Block elements

Blockquotes

A line that starts with a right angle bracket > (optionally followed by a space) is a blockquote. Blockquotes can be nested but they can't be used inside of lists. Consecutive blockquotes can be separated with two blank lines.

> > Deep blockquote
>
> Shallower blockquote

No blockquote
<blockquote><blockquote><p>Deep blockquote</p></blockquote>

<p>Shallower blockquote</p></blockquote>

<p>No blockquote</p>

Lists

*, - and + for unordered lists, or any number of digits followed by a dot such as 1. for an ordered list. The list item must be followed by a space then at least one character. Lists can be nested and can be used inside of blockquotes.

The indentation inside of nested lists emulates the behaviour of the original Markdown, meaning that sublists after the first should be indented by 4 spaces or a tab.

If a list has any of its text content or list items separated with a blank line, each of its items' content is wrapped in a paragraph. Consecutive lists can be separated with two blank lines.

1. Collect underpants
2. **?**
3. Profit
<ol><li>Collect underpants</li>
<li><strong>?</strong></li>
<li>Profit</li></ol>
- Milk
- Bread
- Nutella
<ul><li>Milk</li>
<li>Bread</li>
<li>Nutella</li></ul>

Indented code blocks

A series of lines indented by at least 4 spaces or a tab, preceded with an empty line.

Check out this program:

    10 PRINT "Hello"
    20 GOTO 10

Fenced code blocks

A series of lines between two markers composed of at least 3 consecutive ` or ~ and identical in length. The name of the programming language can be appended to the first marker.

```html
<div class="banner">...</div>
```

Headers

Setext-style

This is an H1
=============

This is an H2
-------------
<h1>This is an H1</h1>

<h2>This is an H2</h2>

Atx-style

# This is an H1

## This is an H2

###### This is an H6
<h1>This is an H1</h1>

<h2>This is an H2</h2>

<h6>This is an H6</h6>

Horizontal rules

Each of those creates an horizontal rule.

* * *

***

*****

- - -

---------------------------------------

Paragraphs and line breaks

Paragraphs are automatically created. Newlines are ignored by default, line breaks can be forced by ending a line with two spaces.

normal
forced  
another line
<p>normal
forced  <br>
another line</p>

Alternatively, automatic line breaks can be enabled globally with a enabledAutoLineBreaks rule as in the following example.

$configurator = new s9e\TextFormatter\Configurator;
$configurator->plugins->load('Litedown');

// Enable automatic line breaks globally
$configurator->rootRules->enableAutoLineBreaks();

// Get an instance of the parser and the renderer
extract($configurator->finalize());

$text = "First line\n"
      . "Second line";
$xml  = $parser->parse($text);
$html = $renderer->render($xml);

echo $html;
<p>First line<br>
Second line</p>

Formatting elements

Note that special characters inside links can be escaped with a backslash.

[Link text](http://example.org)
[Link text](http://example.org "Link title")
[Link text](http://example.org 'Link title')
[Link text](http://example.org (Link title))
[Mars](http://en.wikipedia.org/wiki/Mars_(disambiguation))
[Mars](http://en.wikipedia.org/wiki/Mars_\(disambiguation\))
<p><a href="http://example.org">Link text</a>
<a href="http://example.org" title="Link title">Link text</a>
<a href="http://example.org" title="Link title">Link text</a>
<a href="http://example.org" title="Link title">Link text</a>
<a href="http://en.wikipedia.org/wiki/Mars_%28disambiguation%29">Mars</a>
<a href="http://en.wikipedia.org/wiki/Mars_%28disambiguation%29">Mars</a></p>

Emphasis

A pair of * or _ marks emphasis (<em>) while a pair of ** or __ marks strong emphasis (<strong>). One exception: a single _ between two ASCII alphanumerical characters is kept as-is.

un*frigging*believable

perform_complicated_task
<p>un<em>frigging</em>believable</p>

<p>perform_complicated_task</p>

When a block of three * or _ is found, the order of strong/em depends on the next series of * or _ characters.

***foo* bar**

***foo** bar*
<p><strong><em>foo</em> bar</strong></p>

<p><em><strong>foo</strong> bar</em></p>

Strikethrough

Any text between two ~~ markers.

90s haircuts are ~~cool~~ ~~lame~~ cool again.
<p>90s haircuts are <del>cool</del> <del>lame</del> cool again.</p>

Superscript

E=mc^2

foo^bar^baz
<p>E=mc<sup>2</sup></p>

<p>foo<sup>bar<sup>baz</sup></sup></p>

Inline code

Any text between two markers of same length, entirely composed of backticks ` and neither preceded or followed by a backtick. Leading and trailing whitespace is removed. The backslash does not escape characters inside of a code span.

Single `print("``")` or double ``print("`")``
<p>Single <code>print("``")</code> or double <code>print("`")</code></p>

Inline elements

Images

![](http://example.org/img.png)
![Alt text](http://example.org/img.png)
![Alt text](http://example.org/img.png "Image title")
[![Alt text](http://example.org/img.png)](http://example.org/)
<p><img src="http://example.org/img.png" alt="">
<img src="http://example.org/img.png" alt="Alt text">
<img src="http://example.org/img.png" alt="Alt text" title="Image title">
<a href="http://example.org/"><img src="http://example.org/img.png" alt="Alt text"></a></p>