Static website on GitHub Pages

Sat Jan 30, 2016

GitHub Pages is a great way to have a website hosted directly from your GitHub repository. You get one site per GitHub account and organization, and unlimited project sites.

For the user or organization, the website is hosted at http://username.github.io

For a project site, the URL is http://username.github.io/projectRepository

There are options to allow you to set up a custom domain with GitHub Pages.

GitHub provides step-by-step directions on how to set everything up at https://pages.github.com.

Pricing

GitHub provides a free tier (no private repositories - public repos only). This can be a very inexpensive way for you to host a static website.

See https://github.com/pricing for more information.

Additional documentation:

Project Pages

Unlike User and Organization Pages, Project Pages are kept in the same repository as their project. Both personal accounts and organizations can create Project Pages. The URL for a personal account’s Project Page will be ‘http(s)://.github.io/’ , while an organization’s URL will be ‘http(s)://.github.io/’ . The steps for creating Project Pages are the same for both.

Project Pages are similar to User and Organization Pages, with a few slight differences:

You can build and publish Project Pages sites from the master or gh-pages branch. You can also publish your site from a /docs folder on your master branch. For more information, see “Configuring a publishing source for GitHub Pages.”

If no custom domain is used, the Project Pages sites are served under a subpath of the User Pages site: username.github.io/projectname