content_processor.rdiscount

SummaryConverts content written in Markdown to HTML
Short namerdiscount
Content typetext
Provided by bundlebuilt-in
API docWebgen::ContentProcessor::RDiscount

Description

This processor converts the content, which is assumed to be in Markdown markup, to HTML by using the RDiscount library. This library is based on the C based discount library which provides very fast Markdown processing. However, this processor does not support advanced features like the content processor kramdown does.

This extension is only available if the rdiscount library is installed. The preferred way to do this is via Rubygems:

$ gem install rdiscount

Usage

This processor is intended to be used in the processing pipeline of page files.

Have a look at the RDiscount homepage for more information on the supported markup!

Example

Here is a short sample of a text in Markdown markup:

# This a h1 header

You can just write *your* paragraphs here and
[link][1] them below. This is **nice** format!

> Citations are easy too.
> Really. And you can assign them attributes.

* Lists
* aren't
* difficult
* either.

[1]: http://someurl.com

When processed by this processor, the output would look like this:

<h1>This a h1 header</h1>

<p>You can just write <em>your</em> paragraphs here and
<a href="http://someurl.com">link</a> them below. This is <strong>nice</strong> format!</p>

<blockquote><p>Citations are easy too.
Really. And you can assign them attributes.</p></blockquote>

<ul>
<li>Lists</li>
<li>aren't</li>
<li>difficult</li>
<li>either.</li>
</ul>