Build a Micro Static Site With GitHub Pages


In repository settings, enable GitHub Pages for the master branch.

Now you can access your site at

Done. Period.


GitHub Pages will use as index page. And your project probably already have one. There is no need to write index.html or


Focus on content, not the site design and configuration.

We use and master branch. This makes updating project site easier. Just update without the hassles of sync documentation between master and gh-pages branches.


Your project may have some additional documentary pages. They are welcome by GitHub Pages.

For example:

URL paths will be:


And you can link them as [quick start](, so the link will work on both GitHub and GitHub Pages.


Yes. You can have a site powered by GitHub Page up and running without writing a single line of yaml configuration, html template, css, javascript, etc.