diff --git a/README.md b/README.md index 02807c15..c095e555 100644 --- a/README.md +++ b/README.md @@ -81,10 +81,10 @@ Installation examples for individual systems can be seen [here](https://github.c ### Markups Gollum presently ships with support for the following markups: -* [Markdown](http://daringfireball.net/projects/markdown/syntax) +* [Markdown](http://daringfireball.net/projects/markdown/syntax) (see [below](#Markdown-flavors) for more information on Markdown flavors) * [RDoc](http://rdoc.sourceforge.net/) -Since all markups are rendered by the [github-markup](https://github.com/github/markup) gem, you can easily add support for other markups by additional installation: +You can easily activate support for other markups by installing additional renderers (any that are supported by [github-markup](https://github.com/github/markup)): * [AsciiDoc](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) -- `[sudo] gem install asciidoctor` * [Creole](http://www.wikicreole.org/wiki/CheatSheet) -- `[sudo] gem install creole` * [MediaWiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `[sudo] gem install wikicloth` @@ -92,12 +92,14 @@ Since all markups are rendered by the [github-markup](https://github.com/github/ * [Pod](http://perldoc.perl.org/perlpod.html) -- requires Perl >= 5.10 (the `perl` command must be available on your command line) * Lower versions should install `Pod::Simple` from CPAN. * [ReStructuredText](http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html) -- requires python >= 2 (the `python2` command must be available on your command line) - * Note that Gollum will also need you to install `docutils` for your Python 2. Installation procedure can, again, vary depending on operating system and package manager. + * Note that Gollum will also need you to install `docutils` for your Python 2. * [Textile](http://redcloth.org/hobix.com/textile/quick.html) -- `[sudo] gem install RedCloth` -By default, Gollum ships with the `kramdown` gem to render Markdown. However, you can use any [Markdown renderer supported by github-markup](https://github.com/github/markup/blob/master/lib/github/markup/markdown.rb). The first installed renderer from the list will be used. So, for example, `redcarpet` will NOT be used if `github/markdown` is installed. +### Markdown flavors -See [here](https://github.com/gollum/gollum/wiki/Custom-rendering-gems) for instructions on how to use custom rendering gems. +By default, Gollum ships with the `kramdown` gem to render Markdown. However, you can use any [Markdown renderer supported by github-markup](https://github.com/github/markup/blob/master/lib/github/markup/markdown.rb). This includes [CommonMark](https://commonmark.org/) support via the `commonmarker` gem. The first installed renderer from the list will be used (e.g., `redcarpet` will NOT be used if `github/markdown` is installed). Just `gem install` the renderer of your choice. + +See [here](https://github.com/gollum/gollum/wiki/Custom-rendering-gems) for instructions on how to use custom rendering gems and set custom options. ## RUNNING