Replace backticks with HTML tags

Prior to the change backticks were used in an attempt to create a
code block. The problem is that inside block level HTML tags Markdown
is not supported. I have replaced the backticks with a combination of
HTML tags in order to approximately simulate the appearance of a code
block. The docs suggest possible use of span tags in place of the
surrounding div tags as a solution to getting the Markdown to render.
I tried this but no success.

This change improves the readers understanding of the information,
because the reader doesn't have to make sense of raw markdown.
This commit is contained in:
alexmalik 2016-10-01 23:14:12 +01:00 committed by Pat Hawks
parent 8d4803eb6d
commit 127704ad17
1 changed files with 7 additions and 11 deletions

View File

@ -54,26 +54,22 @@ few minor details.
currently-deployed version of the gem in your project, add the
following to your <code>Gemfile</code>:
```ruby
source 'https://rubygems.org'
<p><code>source 'https://rubygems.org'</code></p>
require 'json'
require 'open-uri'
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
<p><code>require 'json'</code></p>
<p><code>require 'open-uri'</code></p>
<p><code>versions = JSON.parse(open('https://pages.github.com/versions.json').read)</code></p>
gem 'github-pages', versions['github-pages']
```
<p><code>gem 'github-pages', versions['github-pages']</code></p>
This will ensure that when you run <code>bundle install</code>, you
have the correct version of the <code>github-pages</code> gem.
If that fails, simplify it:
```ruby
source 'https://rubygems.org'
<p><code>source 'https://rubygems.org'</code></p>
gem 'github-pages'
```
<p><code>gem 'github-pages'</code></p>
And be sure to run <code>bundle update</code> often.