A smart and small starter kit for building a Jekyll website to host on Github Pages:
- Wiki-style editing workflow:
- Pre-configured for Prose:
- Bootstrap. Remove it if you like.
- Fork this repo.
- Rename the fork to YOURNAME.github.io in project settings to enable Github Pages.
- Delete the CNAME file.
At this point your new site should be up!
To finish, go through _config.yml and customize the name, description, etc.
Why are there two branches, master and gh-pages?
Github pages uses the
master branch if you name your project
YOURNAME.github.io. Otherwise, it uses the
gh-pages branch, and serves your site at
YOURNAME.github.io/PROJECTNAME. I keep both branches up to date so you can use it either way without creating a branch. After you fork, you can delete the unused branch to avoid confusion.
Why don't my edits show up immediately?
Github Pages caches pages for 10 minutes whenever they are accessed. If you make a change while the page is cached, you will still see the old page until the cached page expires.
To bypass the cache, add a "cache-busting" query string after the URL, like so:
How do I troubleshoot build failures?
If you have an error in one of your pages or templates, the new version will fail to build and Github will send you an email lacking any detail about what caused the failure.
To see the error you can run Jekyll locally on a workstation.
How can I enable SSL on Github Pages with a custom domain?
Front Github pages with a free Cloudflare account, as detailed in this article.