Step by step guide for hosting static site in github
Github allow us to host static site in github for free. It also support static site builder like
jekyll. But let’s limit this article on hosting plain static site.
Simple steps for hosting static sites.
- Create a github account if you already don’t have one here”.
Advance user can use git & terminal to sync and push it to github
- Download either GitHub for Mac or GitHub for Windows, depending on your operating system. Open the app and log in using the account you just created. [For the advance user, you can use terminal and ssh to clone repository].
- [For Mac:]After you login, click advanced and make sure that your name and email are correct. Then, click “Install Command Line Tools”, just in case you want to start using the command line later in life.
- Create a new repository in your GitHub application. Name it your-username.github.io. The name is very important. Note the folder that GitHub is saving the repository to. Make sure the “Push to GitHub?” box is checked.
- Move your website’s files into the folder that GitHub just created when you made the repository. IMPORTANT: Your homepage HTML file must be called “index.html”, and it must exist in the top-level directory.
- Back in the GitHub application, you should see your files in the left column. Make sure they are all checked. If so, enter a message in the text box called “commit summary”, something like “initial commit.” Then, click the commit button.
- Click the “Publish repo” button in the top right corner.
- Give it about 10 minutes, then check your-username.github.io. Your website should be there!
Using a custom domain name
You can just leave your website at that address (it’ll give you some serious street cred in the developer world), but if you have a custom domain you would like to use, it is very simple to make GitHub redirect your page.
- Log in to your domain registrar and find where to change your host records. If you don’t know, you can usually Google “(domain registrar) change host records”, and your registrar will have an explainer telling you how to do it.
- Change your domain’s A Record to 220.127.116.11. This is GitHub’s IP address, which allows GitHub to resolve your URL and serve the correct files.
- In your website’s directory folder on your computer, create a file called “CNAME”. On the first line, type your domain name. Save the file.
- In your GitHub application, you should see the file in the left column. Make sure it is checked and enter your commit message. Have it say something like “Adding CNAME file.”
- Click “Sync branches.”
It can take as long as 48 hours for your domain to resolve to your GitHub page. However, it is usually pretty quick, so check back in an hour or so.