content_processor.maruku

SummaryConverts content written in a superset of Markdown to HTML
Short namemaruku
Content typetext
Provided by bundlebuilt-in
API docWebgen::ContentProcessor::Maruku

Description

This processor converts the content, which is assumed to be in Markdown markup, to HTML by using the Maruku library. Maruku is a Markdown processor which supports a superset of Markdown, including support for assigning ids and classes to every element, support for Markdown inside HTML elements and footnotes.

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

gem install maruku

Usage

For detailed information about Maruku have a look at the Maruku Homepage. There you will find information about the general Markdown syntax as well as information about the extras added by Maruku.

The Maruku library is not maintained anymore. It is recommended to use the kramdown processor instead since it provides a nearly drop-in replacement and is actively supported.

Example

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

# This a h1 header    {#myid}

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.
{.information}

* Lists
* aren't
* difficult
* either.

[1]: http://someurl.com

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

<h1 id="myid">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 class="information">
<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>