This quick start guide will help you to set up a basic GitHub Pages site as well as select a pre-made Jekyll theme.
For this walk-through, you will need:
1. A GitHub account
2. An internet connection
3. A web browser
4. Basic knowledge of how to edit files in GitHub
GitHub Pages is a static webpage hosting service that allows you to create and publish GitHub Pages sites online. The quickest way to get a page, whether that be a blog or your online portfolio, up and running is by using the Jekyll Theme Chooser to load a pre-made theme.
If you still aren't 100% sure what GitHub Pages can do for you, watch this video:
Let’s Get Started:
1. Sign into GitHub.
2. Once signed in, click the plus sign in the upper right corner. Select “New Repository”.
3. On the new repository page, you will need to name your repository “username.github.io” where “username” will be replaced with your GitHub username.
Click ‘Create Repository”. You will be redirected to the repository you just created.
4. After the repository is set up, click on "Settings".
5. Scroll down through the settings until you see the GitHub pages section, click on “choose a theme”.
6. You will be redirected to the Theme Chooser.
Feel free to browse and preview each of the theme options.
Once you have settled on an option, click “Select Theme” to save it. (Don’t worry, this option can be changed later.)
7. After selecting your theme, you will be redirected to the ‘index.md’ file of your repository.
This is where you will write your own content, however, for the sake of our tutorial we will be leaving the preloaded content here.
If you’d like to go ahead and edit this page, feel free to do so.
8. Scroll to the bottom to prepare to commit the changes made.
If you kept the default content, you can leave the auto-generated commit message ‘update index.md’.
However, if you edited the content feel free to alter this message to more accurately reflect the changes made. Be accurate but brief with your commit messages.
9. Click "Commit Changes".
GitHub will do all the work on their side to prepare this repository to be viewed online as a website. (This can take up to 10 minutes.)
Once ready, visitors to ‘https://username.github.io’ will be able to view your site.
In summary, the above nine steps will help you to set up a basic GitHub Pages site with a pre-made Jekyll theme. To further customize your site, here are some resources that will help:
Sara McCombs is a freelance writer, aspiring full-stack developer, business owner, and dedicated mother.
After obtaining two degrees in agriculture, Sara has followed her interests and pursued every opportunity to learn and grow.
When she’s not chasing her daughter around outside, she enjoys a good book, an Americano, and the company of her husband and dogs.