This is a renderer plugin that implements the text transformation of Markdown syntax for HTML formatting. Due to its specific markup you could create HTML elements in a fast and comprehensive way.

Per Collection Settings

This plugin provides per-collection settings to let you set different behaviors on each one of the collections of your site.

• Apply rendering to posts: how the content of the post will be rendered (for more information about apply rendering, please read: )
• Apply rendering to comments: how the comments will be rendered (for more information about apply rendering, please read: )
• Links: render well formed a tags based on the URLs included in the text.
• Images: render well formed img tags based on the text found in the content that has been written using the specific markdown syntax.
• Italic & Bold styles: render Phrase Emphasis according when the markdown syntax is used to produce em or strong tags.

Supported Markdown Syntax

Up next you will find some samples about the Markdown syntax:

Headings

Headings will be produced placing the number of hashes # according with the level that you want to assign to the phrase using the html H[N] tag. It will work in both ways, putting hashes only at the begin of the expression or wrapping it up with the same number of hashes. There is no practical difference between those method and they could be used as you wish.

# First-level heading - Dashes at the beginning

#### Fourth-level heading

## Second level heading (closed style) ##

This translates into:

<h1>First-level heading - Dashes at the beginning</h1>
<h4>Fourth-level heading</h4>
<h2>Second level heading (closed style)</h2>

You also could define first and second level headings by using this mode:

First-level heading
===================

Second-level heading
--------------------

Paragraphs

You could insert a paragraph leaving one or more blank lines after the end of the final sentence. This way, all the text before that blank line(s) will be wrapped by HTML P tags.

This is a paragraph. It has two sentences.

This is another paragraph. It also has 
two sentences.

The HTML produced by Markdown will look like this:

<p>This is a paragraph. It has two sentences.</p>
<p>This is another paragraph. It also has two sentences.</p>

List

You could use both, ordered <ol> and unordered <ul> lists.

Ordered lists

Put a number followed by a point at the beginning of the line. Note that you could actually place any number, all that they need is to be ended with a point and Markdown will replace them and set the HTML code as a sequence.

1. Element 1
1. Element 2
3. Element 3
20. Element 4

This translates into:

<ol>
<li>Element 1</li>
<li>Element 2</li>
<li>Element 3</li>
<li>Element 4</li>
</ol>

Unordered lists

Start each element with any of these characters: dash ( - ), add sign ( + ) or asterisk ( * ). You could mix them up as you wish and the result will be always the same.

- Element 1
- Element 2
+ Element 3
* Element 4

This translates into:

<ul>
<li>Element 1</li>
<li>Element 2</li>
<li>Element 3</li>
<li>Element 4</li>
</ul>

Blockquotes

Blockquotes could be defined preceding each new line with angle brackets ( > ).

> Email-style angle brackets
> are used for blockquotes.

> > And, they can be nested.

This translates into:

<blockquote>
  <p>Email-style angle brackets are used for blockquotes.</p>

  <blockquote>
    <p>And, they can be nested.</p>
  </blockquote>
</blockquote>

Codespans

The HTML span tags are delimited by backticks ( ` ).

`some_code_here` and the rest of the sentence.

This translates into:

< code >some_code_here< / code > and the rest of the sentence.

Codeblocks

You could set multi-line code pieces indenting them by four ( 4 ) blank spaces or a tab.

This is a normal paragraph.

    This is a pre-formatted
    code block.

This translates into:

<p>This is a normal paragraph.</p>

<pre><code>This is a pre-formatted
code block.

Horizontal rules

Use three or more dashes ( - ) or asterisks ( * ) in order to produce a <hr />

---
***
- - - -

This translates into:

<hr />
<hr />
<hr />

Additional Markup Support

This plugin supports the use of specific markup for links, images and emphasis. Those options are disabled by default as b2evolution offers other, more practical ways, to achieve these results.

If you want to use these options, you can enable them in [Your collection] > Settings > Plugins settings.

Links

Option 1 (inline link):
This is [an example](http://example.com/ "Optional Title Here")

Option 2 (reference-style link):
This is [an example] [id]
[id]: http://example.com/ "Optional Title Here"

Both options will produce exactly the same HTML:

This is <a href="http://example.com/" title="Optional Title Here">an example</a>

Images


This translates into:

<img src="http://b2evolution.net/rsc/img/b2evolution8.png" alt="Alt text" title="Optional title" />

Emphasis

*single asterisks*
_single underscores_
double asterisks
double underscores

This translates into:

<em>single asterisks</em>
<em>single underscores</em>
<strong>double asterisks</strong>
<strong>double underscores</strong>

Priority Requirements for this Plugin

This plugin priority is set to 20 by default. Please note that this plugin could have issues when combined with other Text renderers and the following situations needs to be taken in care:

• Must be after Wiki Tables Plugin, because Markdown creates tags <p> and <br> inside table structure and then Wiki Tables plugin can not build the broken tables structure.
• Must be before Gmcode Plugin, because GM Code brakes down h2 code by creating <tt> from ##tt##. So when these two plugins are enabled the second code does not work.
• Must be before Autolinks Plugin, because Auto Links replaces all text "http://mydomain.com" with links, and it breaks the link code of Markdown plugin.

For a more details about the markdown syntax, please visit: http://daringfireball.net/projects/markdown/syntax, but remember that not all the features shown there are supported by this plugin.