Getting Started
1 Creating a GitHub Account
- If you don’t already have one, you will need a GitHub account to get started with your GitHub hosted Digital Portfolio.
- We recommend not to use your education account, as it may become inaccessible upon graduation.
2 Creating a New Repo
Once logged into your GitHub account, you will need to create a new repository with the following steps.
- Click the icon to create a new repository.
- Name your repository anything you like (e.g. “digitalportfolio”).
- Set visibility to public.
- Select to add a ReadMe.
3 Create an “index.md” File
- Once you have created your repository, create a new markdown file within it called “index.md”. Commit this file (default settings). From your repository, go to Settings.
4 Publish Your Repository
In Settings > Pages, set up your repo to publish
- From your repository, go to settings (cog icon top left)
- On the left hand side, scroll down to Pages.
- In the “Source” section, select the main branch.
Publishing to GitHub Pages GIF
5 Choose a Theme for Your Site
- Choose a theme - this will be the template for your site.
- Hit “select theme”.
6 Publish Your Site
- You are now on the markdown file which is the basis of your site. This is what you can later edit to add content to your site. For now, you can go ahead and commit to publish.
- Our site is published at https://digitalportfolio.github.io/guide - Yours will be published at
.github.io/ (the url can also be found in your settings > Pages).
7 Edit Your Pages
You can edit the code in index.md to customize text, add images
- Go to Creating Content to learn how to start building content for your site.
- Your GitHub page can be edited in Markdown, a lightweight markup language. Here is a cheat sheet of some basic Markdown syntax to get you started with editing your page and adding content.
- When you edit the markdown file with your main content and commit, your site will update automatically. If you are having trouble accessing the latest version, it may be that your browser has cached an older version. Ensure that you have Disabled Cache, or try opening in a private browsing tab.
