Sha256: e6963db78e40294bca3aa01645b33af3b674734b37c4d4deb46e61137f303ec3

Contents?: true

Size: 1.17 KB

Versions: 3

Compression:

Stored size: 1.17 KB

Contents

---
title: Webgen::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. The short name of the processor is `maruku`!

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

> Maruku is the default markup content processor for webgen as its markup syntax is easy to learn
> and nice to look at. Give it a try!
{.info}

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


[1]: http://maruku.rubyforge.org/

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
webgen-0.5.1 doc/contentprocessor/maruku.page
webgen-0.5.2 doc/contentprocessor/maruku.page
webgen-0.5.3 doc/contentprocessor/maruku.page