From 52b3afdb714022dbab8260d77404df954522bcb2 Mon Sep 17 00:00:00 2001 From: John Hughes Date: Tue, 16 Jul 2013 20:30:22 +0100 Subject: [PATCH 1/3] Update Extras page in the docs to include Kramdown to fix #1313 --- site/docs/extras.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/site/docs/extras.md b/site/docs/extras.md index db25ebf5..3344f8ac 100644 --- a/site/docs/extras.md +++ b/site/docs/extras.md @@ -19,7 +19,7 @@ fork](http://github.com/remi/maruku). ## RDiscount If you prefer to use [RDiscount](http://github.com/rtomayko/rdiscount) instead -of [Maruku](http://github.com/bhollis/maruku) for markdown, just make sure you have +of [Maruku](http://github.com/bhollis/maruku) for Markdown, just make sure you have it installed: {% highlight bash %} @@ -33,3 +33,24 @@ have Jekyll run with that option. # In _config.yml markdown: rdiscount {% endhighlight %} + +## Kramdown + +You can also use [Kramdown](http://kramdown.rubyforge.org/) instead of Maruku +for Markdown. Make sure that Kramdown is installed: + +{% highlight bash %} +$ sudo gem install kramdown +{% endhighlight %} + +Then you can specify Kramdown as the Markdown engine in `_config.yml`. + +{% highlight bash %} +# In _config.yml +markdown: kramdown +{% endhighlight %} + +Kramdown has various options for customizing the HTML output. The +[Configuration](/docs/configuration/) page lists the default options used by +Jekyll. A complete list of options is also available on the [Kramdown +website](http://kramdown.rubyforge.org/options.html). From aae84c4180b84c29a538f29ad552eac7099ed063 Mon Sep 17 00:00:00 2001 From: John Hughes Date: Tue, 16 Jul 2013 21:01:01 +0100 Subject: [PATCH 2/3] Add brackets around sudo on Extras page --- site/docs/extras.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/docs/extras.md b/site/docs/extras.md index 3344f8ac..11ecce8f 100644 --- a/site/docs/extras.md +++ b/site/docs/extras.md @@ -23,7 +23,7 @@ of [Maruku](http://github.com/bhollis/maruku) for Markdown, just make sure you h it installed: {% highlight bash %} -$ sudo gem install rdiscount +$ [sudo] gem install rdiscount {% endhighlight %} And then specify RDiscount as the Markdown engine in your `_config.yml` file to @@ -40,7 +40,7 @@ You can also use [Kramdown](http://kramdown.rubyforge.org/) instead of Maruku for Markdown. Make sure that Kramdown is installed: {% highlight bash %} -$ sudo gem install kramdown +$ [sudo] gem install kramdown {% endhighlight %} Then you can specify Kramdown as the Markdown engine in `_config.yml`. From 2e8c4359a1029101aefd41fb396d748b823b9f1f Mon Sep 17 00:00:00 2001 From: John Hughes Date: Tue, 16 Jul 2013 21:06:30 +0100 Subject: [PATCH 3/3] Change syntax highlighting to YAML on Extras page --- site/docs/extras.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/docs/extras.md b/site/docs/extras.md index 11ecce8f..0c190ec1 100644 --- a/site/docs/extras.md +++ b/site/docs/extras.md @@ -29,7 +29,7 @@ $ [sudo] gem install rdiscount And then specify RDiscount as the Markdown engine in your `_config.yml` file to have Jekyll run with that option. -{% highlight bash %} +{% highlight yaml %} # In _config.yml markdown: rdiscount {% endhighlight %} @@ -45,7 +45,7 @@ $ [sudo] gem install kramdown Then you can specify Kramdown as the Markdown engine in `_config.yml`. -{% highlight bash %} +{% highlight yaml %} # In _config.yml markdown: kramdown {% endhighlight %}