GitHub Pages Tutorial

Getting a public webpage for your project is super easy and can be done at no cost.

Good to Know: This page is still a work in progress.

GitHub Pages

Setting up Pages for your GitHub repository is a fantastic way to get a website front-end (free for public repositories). In many cases if your app, mod or utility can run in static web pages this can save you a lot of time and money getting your own website hosting. You can further improve by connecting custom domains while letting GitHub Pages handle the web hosting.

From your GitHub repository:

1. Click Settings

2. Navigate to "Code and Automation" and click Pages

3. Leave the selection "Deploy from a branch"

4. Choose a Default Branch from the dropdown (e.g. main)

5. Select a subfolder (e.g. /root/ for everything or /docs/ if you just want doc pages published)

6. Click Save

7. Optionally setup a custom domain

Pro Tip: Get a great quick start with the very helpful information on GitHub Pages.

Getting a public webpage for your project is super easy and can be done at no cost.