From 3ca2cb0119608a2f31c5561917c9de4c4ab4d663 Mon Sep 17 00:00:00 2001 From: Robin Dupret Date: Mon, 23 Dec 2013 12:42:38 +0100 Subject: [PATCH] Fix various typos and improve the doc --- lib/jekyll/configuration.rb | 2 +- lib/jekyll/deprecator.rb | 3 ++- site/docs/installation.md | 7 ++++--- site/docs/posts.md | 4 ++-- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/lib/jekyll/configuration.rb b/lib/jekyll/configuration.rb index 53e0bf4f..27058f54 100644 --- a/lib/jekyll/configuration.rb +++ b/lib/jekyll/configuration.rb @@ -213,7 +213,7 @@ module Jekyll Jekyll.logger.warn "Deprecation:", "The 'pygments' configuration option" + " has been renamed to 'highlighter'. Please update your" + " config file accordingly. The allowed values are 'rouge', " + - "'pygments' or null" + "'pygments' or null." config['highlighter'] = 'pygments' if config['pygments'] config.delete('pygments') diff --git a/lib/jekyll/deprecator.rb b/lib/jekyll/deprecator.rb index 0fdb7a7b..7600cd29 100644 --- a/lib/jekyll/deprecator.rb +++ b/lib/jekyll/deprecator.rb @@ -9,7 +9,8 @@ module Jekyll arg_is_present? args, "--auto", "The switch '--auto' has been replaced with '--watch'." arg_is_present? args, "--no-auto", "To disable auto-replication, simply leave off \ the '--watch' switch." - arg_is_present? args, "--pygments", "The 'pygments' setting has been removed" + arg_is_present? args, "--pygments", "The 'pygments'settings has been removed in \ + favour of 'highlighter'." arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in your \ config files." arg_is_present? args, "--url", "The 'url' setting can only be set in your config files." diff --git a/site/docs/installation.md b/site/docs/installation.md index 977e9d9c..7e4bd570 100644 --- a/site/docs/installation.md +++ b/site/docs/installation.md @@ -66,9 +66,10 @@ Check out [the extras page](../extras/) for more information.
ProTip™: Enable Syntax Highlighting

If you’re the kind of person who is using Jekyll, then chances are you’ll - want to enable syntax highlighting using Pygments or Rouge. You should - really check out how to - do that before you go any further. + want to enable syntax highlighting using Pygments + or Rouge. You should really + check out how to + do that before you go any farther.

diff --git a/site/docs/posts.md b/site/docs/posts.md index 73899a3b..e944885e 100644 --- a/site/docs/posts.md +++ b/site/docs/posts.md @@ -139,8 +139,8 @@ your `excerpt_separator` to `""`. ## Highlighting code snippets Jekyll also has built-in support for syntax highlighting of code snippets using -either Pygments or [Rouge](https://github.com/jayferd/rouge), and including a -code snippet in any post is easy. Just use the dedicated Liquid tag as follows: +either Pygments or Rouge, and including a code snippet in any post is easy. Just +use the dedicated Liquid tag as follows: {% highlight text %} {% raw %}{% highlight ruby %}{% endraw %}