What is GitHub Pages?
Who uses GitHub Pages?
GitHub Pages Integrations
Why developers like GitHub Pages?
Here are some stack decisions, common use cases and reviews by companies and developers who chose GitHub Pages in their tech stack.
We recently needed to rebuild our documentation site, currently built using Jekyll hosted on GitHub Pages. We wanted to update the content and refresh the style to make it easier to find answers.
We considered hosted services that could accept our markdown content, like ReadMe.io and Read the Docs, however both seemed expensive for essentially hosting the same platform we already had for free.
I also looked at the Gatsby Static Site generator to modernize Jekyll. I don't think this is a fit, as our documentation is relatively simple and relies heavily on Markdown. Jekyll excels at Markdown, while Gatsby seemed to struggle with it.
When my SSL cert MaxCDN was expiring on my personal site I decided it was a good time to revamp some things. Since GitHub Services is depreciated I can no longer have #CDN cache purges automated among other things. So I decided on the following: GitHub Pages, Netlify, Let's Encrypt and Jekyll. Staying the same was Bootstrap, jQuery, Grunt & #GoogleFonts.
What's awesome about GitHub Pages is that it has a #CDN (Fastly) built-in and anytime you push to master, it purges the cache instantaneously without you have to do anything special. Netlify is magic, I highly recommend it to anyone using #StaticSiteGenerators.
For the most part, everything went smoothly. The only things I had issues with were the following:
- If you want to point
wwwto GitHub Pages you need to rename the repo to
- If you edit something in the
_config.ymlyou need to restart
bundle exec jekyll sor changes won't show
- I had to disable the Grunt
htmlminmodule. I replaced it with Jekyll layout that compresses HTML for #webperf
Last but certainly not least, I made a donation to Let's Encrypt. If you use their service consider doing it too: https://letsencrypt.org/donate/
We have many #OpenSource libraries. Some of them need a demo besides documentation. We use GitHub Pages for a demo of libraries. We create a demo folder near with code of the library, add index.html with demo code and publish files only from demo folder to gh-pages. Fast and simple.
Git and GitHub are excellent tools for hosting this open source project. GitHub enables me to do reviews and provides wiki support via GitHub Pages from anywhere. Travis CI is easy to setup and I can pull up my own Android SDK libraries from BinTray .
GitHub Pages's features
- Blogging with Jekyll
- Custom URLs
- Automatic Page Generator