CS220AU

GitHub

1. Sign up to GitHub
   • you will need an email address (perhaps use your student email address)
   • your username must be your student number (ask me if you are unsure!)
   • use a good password (check the pw.md file for ideas)
2. Create a private repository
   • for your private notes
   • name it ‘private notes’
   • initialise it with README.md file
3. Fork my ‘CS220AU-DP-2022’ repository
   • this will be the digital portfolio (your assignment to submit)
   • this repository will host your website as well

Markdown language

Familiarise yourself with Markdown language. A link to this guide can be found in the editor:

thoughts

• choose ‘soft wrap’ instead of ‘no wrap’ in the GitHub editor
• there are slightly different Markdown styles, but in general they all work the same (stick to the above link with GitHub)
• we can monitor each other’s progress in the public repositories. Please update it at least once a week.
• is GitHub safe to use (e.g regarding tracking and cookies)?

GitHub/Markdown combo for project management

GitHub’s advantages:

• free
• provides version backup
• accessible and editable on mobiles via browser
• repositories can be synced to your computer (cross-platform) and then you can use desktop software to edit your files (e.g. Visual Studio Code)
• you can drag and drop images to the editor (but I think it’s better to upload it them to your assets folder to stay organised)
• can have project boards similar like Trello if needed
• you can turn your files into a very fast website for free (can be static or more complex e.g. with Jekyll themes.)

GitHub’s disadvantage:

• might look unfamiliar (but it’s easy to learn, and will look good on your CV too)

Markdown advantages:

• its simplicity helps focus on content
• if you can’t find a Markdown function for your needs, you can extend your writing with HTML/CSS and even JavaScript

some shortcuts in the editor

• CTRL+b makes the highlighted words bold
• CTRL+i makes the highlighted words italic
• if you have many files, hit the letter ‘t’ and search for the file you want to edit

further resources

• https://programminghistorian.org/en/lessons/building-static-sites-with-jekyll-github-pages
• https://www.markdownguide.org/getting-started/
• https://grantwinney.com/cool-markdown-tricks-for-github/
• Google Docs has Markdown support