diff --git a/docs/_docs/github-pages.md b/docs/_docs/github-pages.md index 449e4515..b82baa18 100644 --- a/docs/_docs/github-pages.md +++ b/docs/_docs/github-pages.md @@ -42,48 +42,46 @@ There are two basic types available: user/organization pages and project pages. The way to deploy these two types of sites are nearly identical, except for a few minor details. -
-
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. Using it in your projects means that when you deploy - your site to GitHub Pages, you will not be caught by unexpected - differences between various versions of the gems. To use the - currently-deployed version of the gem in your project, add the - following to your Gemfile: -

+
+##### Use the `github-pages` gem - {% highlight ruby %} - source 'https://rubygems.org' +Our friends at GitHub have provided the +github-pages +gem which is used to manage Jekyll and its dependencies on +GitHub Pages. Using it in your projects means that when you deploy +your site to GitHub Pages, you will not be caught by unexpected +differences between various versions of the gems. To use the +currently-deployed version of the gem in your project, add the +following to your `Gemfile`: - require 'json' - require 'open-uri' - versions = JSON.parse(open('https://pages.github.com/versions.json').read) +
+```ruby +source 'https://rubygems.org' - gem 'github-pages', versions['github-pages'] - {% endhighlight %} +require 'json' +require 'open-uri' +versions = JSON.parse(open('https://pages.github.com/versions.json').read) -

- This will ensure that when you run bundle install, you - have the correct version of the github-pages gem. +gem 'github-pages', versions['github-pages'] +``` +

- If that fails, simplify it: -

+This will ensure that when you run `bundle install`, you +have the correct version of the `github-pages` gem. +If that fails, simplify it: - {% highlight ruby %} - source 'https://rubygems.org' +
+```ruby +source 'https://rubygems.org' - gem 'github-pages' - {% endhighlight %} +gem 'github-pages' +``` +
-

- And be sure to run bundle update often. +And be sure to run `bundle update` often. - If you like to install pages-gem on Windows you can find instructions by Jens Willmer on how to install github-pages gem on Windows (x64). -

+If you like to install `pages-gem` on Windows you can find instructions by Jens Willmer on how to install github-pages gem on Windows (x64).