diff --git a/docs/_docs/github-pages.md b/docs/_docs/github-pages.md index b65bad90..b046f0f9 100644 --- a/docs/_docs/github-pages.md +++ b/docs/_docs/github-pages.md @@ -27,7 +27,7 @@ site builds properly, use `site.github.url` in your URL's. -{{ page.title }} +[{{ page.title }}]("{{ page.url | prepend: site.github.url }}") {% endraw %} ``` @@ -42,17 +42,24 @@ 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 + +Our friends at GitHub have provided the +[github-pages](https://github.com/github/pages-gem) +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`: + +
+
+
```ruby source 'https://rubygems.org' @@ -63,22 +70,28 @@ versions = JSON.parse(open('https://pages.github.com/versions.json').read) gem 'github-pages', versions['github-pages'] ``` +
- This will ensure that when you run bundle install, you - have the correct version of the github-pages gem. +This will ensure that when you run `bundle install`, you +have the correct version of the `github-pages` gem. - If that fails, simplify it: +If that fails, simplify it: + +
+
+
```ruby source 'https://rubygems.org' 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)]("http://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins").
@@ -95,8 +108,7 @@ gem 'github-pages' User and organization pages live in a special GitHub repository dedicated to only the GitHub Pages files. This repository must be named after the account -name. For example, [@mojombo’s user page -repository](https://github.com/mojombo/mojombo.github.io) has the name +name. For example, [@mojombo’s user page repository](https://github.com/mojombo/mojombo.github.io) has the name `mojombo.github.io`. Content from the `master` branch of your repository will be used to build and @@ -144,9 +156,8 @@ to see more detailed examples.
GitHub Pages Documentation, Help, and Support

For more information about what you can do with GitHub Pages, as well as for - troubleshooting guides, you should check out GitHub’s Pages Help - section. If all else fails, you should contact GitHub Support. + troubleshooting guides, you should check out + GitHub’s Pages Help section. + If all else fails, you should contact GitHub Support.

diff --git a/docs/_sass/_style.scss b/docs/_sass/_style.scss index 5e441924..f1e3de5f 100644 --- a/docs/_sass/_style.scss +++ b/docs/_sass/_style.scss @@ -670,6 +670,11 @@ h5 > code, font-size: 0.8em; } +.code-block { + margin: 10px 0; + code { background: none; } +} + .highlight { margin: 1em 0; padding: 10px 0;