From 0f008c02d821e859698a0fb317d18fcee3694b0c Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Fri, 19 Sep 2014 19:56:36 -0700 Subject: [PATCH] Add note about using the github-pages gem properly --- site/_docs/github-pages.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/site/_docs/github-pages.md b/site/_docs/github-pages.md index b8bf4d33..b448d510 100644 --- a/site/_docs/github-pages.md +++ b/site/_docs/github-pages.md @@ -12,6 +12,32 @@ organizations, and repositories, that are freely hosted on GitHub's powered by Jekyll behind the scenes, so in addition to supporting regular HTML content, they’re also a great way to host your Jekyll-powered website for free. + +
+
Use the github-pages gem
+

+ Our friends at GitHub have provided the + github-pages + gem which is used to manage Jekyll and its dependencies on + GitHub Pages. To use the currently-deployed version of the + gem in your project, add the following to your `Gemfile`: + + {% highlight ruby %} + source 'https://rubygems.org' + + require 'json' + require 'open-uri' + versions = JSON.parse(open('https://pages.github.com/versions.json').read) + + + gem 'github-pages', versions['github-pages'] + {% endhighlight %} + + This will ensure that when you run bundle install, you + have the correct version of the github-pages gem. +

+
+ ## Deploying Jekyll to GitHub Pages GitHub Pages work by looking at certain branches of repositories on GitHub.