resolve #184

in the old implementation it wasn’t possible to have multiline
definitions

README.md

@@ -1,6 +1,6 @@
 ## Parsedown
 
-Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
+Better Markdown Parser in PHP
 
 [[ demo ]](http://parsedown.org/demo)
 
@@ -8,11 +8,10 @@ Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
 
 * [Fast](http://parsedown.org/speed)
 * [Consistent](http://parsedown.org/consistency)
-* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
+* [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
 * [Tested](http://parsedown.org/tests/) in PHP 5.2, 5.3, 5.4, 5.5, 5.6 and [hhvm](http://www.hhvm.com/)
-* Extensible
+* [Extensible](https://github.com/erusev/parsedown/wiki/Writing-Extensions)
-* [Markdown Extra extension](https://github.com/erusev/parsedown-extra) <sup>new</sup>
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
-* [JavaScript port](https://github.com/hkdobrev/parsedown.js) under development <sup>new</sup>
 
 ### Installation
 
@@ -30,14 +29,20 @@ More examples in [the wiki](https://github.com/erusev/parsedown/wiki/Usage) and
 
 ### Questions
 
-**How does Parsedown work?**<br/>
+**How does Parsedown work?**
-Parsedown recognises that the Markdown syntax is optimised for humans so it tries to read like one. It goes through text line by line. It looks at how lines start to identify blocks. It looks for special characters to identify inline elements.
 
-**Why doesn’t Parsedown use namespaces?**<br/>
+It tries to read Markdown like a human. First, it looks at the lines. It’s interested in how the lines start. This helps it recognise blocks. It knows, for example, that if a line start with a `-` then it perhaps belong to a list. Once it recognises the blocks, it continues to the content. As it reads, it watches out for special characters. This helps it recognise inline elements (or inlines).
-Using namespaces would mean dropping support for PHP 5.2. We believe that since Parsedown is a single class with an uncommon name, making this trade wouldn't be worth it.
 
-**Is Parsedown compliant with CommonMark?**<br/>
+We call this approach "line based". We believe that Parsedown is the first Markdown parser to use it. Since the release of Parsedown, other developers have used the same approach to develop other Markdown parsers in PHP and in other languages.
-We are [working on it](https://github.com/erusev/parsedown/tree/commonmark).
 
-**Who uses Parsedown?**<br/>
+**Is Parsedown compliant with CommonMark?**
-[phpDocumentor](http://www.phpdoc.org/), [October CMS](http://octobercms.com/), [Bolt CMS](http://bolt.cm/), [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
+
+The majority of the CommonMark tests pass. Most of the tests that don't pass deal with cases that are quite extreme. Yet, we are working on them. As CommonMark matures, compliance should improve.
+
+**Who uses Parsedown?**
+
+[phpDocumentor](http://www.phpdoc.org/), [October CMS](http://octobercms.com/), [Bolt CMS](http://bolt.cm/), [Kirby CMS](http://getkirby.com/), [Grav CMS](http://getgrav.org/), [Statamic CMS](http://www.statamic.com/),  [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
+
+**How can I help?**
+
+Use the project, tell friends about it and if you feel generous, [donate some money](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).

test/CommonMarkTest.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * Test Parsedown against the CommonMark spec.
+ *
+ * Some code based on the original JavaScript test runner by jgm.
+ *
+ * @link http://commonmark.org/ CommonMark
+ * @link http://git.io/8WtRvQ JavaScript test runner
+ */
+class CommonMarkTest extends PHPUnit_Framework_TestCase
+{
+    const SPEC_URL = 'https://raw.githubusercontent.com/jgm/stmd/master/spec.txt';
+
+    /**
+     * @dataProvider data
+     * @param $section
+     * @param $markdown
+     * @param $expectedHtml
+     */
+    function test_($section, $markdown, $expectedHtml)
+    {
+        $Parsedown = new Parsedown();
+        $Parsedown->setUrlsLinked(false);
+
+        $actualHtml = $Parsedown->text($markdown);
+        $actualHtml = $this->normalizeMarkup($actualHtml);
+
+        $this->assertEquals($expectedHtml, $actualHtml);
+    }
+
+    function data()
+    {
+        $spec = file_get_contents(self::SPEC_URL);
+        $spec = strstr($spec, '<!-- END TESTS -->', true);
+
+        $tests = array();
+        $currentSection = '';
+
+        preg_replace_callback(
+            '/^\.\n([\s\S]*?)^\.\n([\s\S]*?)^\.$|^#{1,6} *(.*)$/m',
+            function($matches) use ( & $tests, & $currentSection, & $testCount) {
+                if (isset($matches[3]) and $matches[3]) {
+                    $currentSection = $matches[3];
+                } else {
+                    $testCount++;
+                    $markdown = $matches[1];
+                    $markdown = preg_replace('/→/', "\t", $markdown);
+                    $expectedHtml = $matches[2];
+                    $expectedHtml = $this->normalizeMarkup($expectedHtml);
+                    $tests []= array(
+                        $currentSection, # section
+                        $markdown, # markdown
+                        $expectedHtml, # html
+                    );
+                }
+            },
+            $spec
+        );
+
+        return $tests;
+    }
+
+    private function normalizeMarkup($markup)
+    {
+        $markup = preg_replace("/\n+/", "\n", $markup);
+        $markup = preg_replace('/^\s+/m', '', $markup);
+        $markup = preg_replace('/^((?:<[\w]+>)+)\n/m', '$1', $markup);
+        $markup = preg_replace('/\n((?:<\/[\w]+>)+)$/m', '$1', $markup);
+        $markup = trim($markup);
+
+        return $markup;
+    }
+}

test/ParsedownTest.php

@@ -109,22 +109,28 @@ paragraph
         color: red;
     }
 </style>
+
+comment
+
+<!-- html comment -->
 MARKDOWN_WITH_MARKUP;
 
         $expectedHtml = <<<EXPECTED_HTML
-<p>&lt;div><em>content</em>&lt;/div></p>
+<p>&lt;div&gt;<em>content</em>&lt;/div&gt;</p>
 <p>sparse:</p>
-<p>&lt;div>
+<p>&lt;div&gt;
-&lt;div class="inner">
+&lt;div class=&quot;inner&quot;&gt;
 <em>content</em>
-&lt;/div>
+&lt;/div&gt;
-&lt;/div></p>
+&lt;/div&gt;</p>
 <p>paragraph</p>
-<p>&lt;style type="text/css"></p>
+<p>&lt;style type=&quot;text/css&quot;&gt;
-<pre><code>p {
+p {
 color: red;
-}</code></pre>
+}
-<p>&lt;/style></p>
+&lt;/style&gt;</p>
+<p>comment</p>
+<p>&lt;!-- html comment --&gt;</p>
 EXPECTED_HTML;
         $parsedownWithNoMarkup = new Parsedown();
         $parsedownWithNoMarkup->setMarkupEscaped(true);

test/data/atx_heading.html

@@ -4,6 +4,6 @@
 <h4>h4</h4>
 <h5>h5</h5>
 <h6>h6</h6>
-<h6>h6</h6>
+<p>####### not a heading</p>
 <h1>closed h1</h1>
 <p>#</p>

test/data/atx_heading.md

@@ -10,7 +10,7 @@
 
 ###### h6
 
-####### h6
+####### not a heading
 
 # closed h1 #
 

test/data/escaping.html

@@ -2,3 +2,5 @@
 <p><code>escaped \*emphasis\* in a code span</code></p>
 <pre><code>escaped \*emphasis\* in a code block</code></pre>
 <p>\ ` * _ { } [ ] ( ) > # + - . !</p>
+<p><em>one_two</em> <strong>one_two</strong></p>
+<p><em>one*two</em> <strong>one*two</strong></p>

test/data/escaping.md

@@ -5,3 +5,7 @@ escaped \*emphasis\*.
     escaped \*emphasis\* in a code block
 
 \\ \` \* \_ \{ \} \[ \] \( \) \> \# \+ \- \. \!
+
+_one\_two_ __one\_two__
+
+*one\*two* **one\*two**

test/data/image_reference.html

@@ -1 +1,2 @@
-<p><img alt="Markdown Logo" src="/md.png" /></p>
+<p><img src="/md.png" alt="Markdown Logo" /></p>
+<p>![missing reference]</p>

test/data/image_reference.md

@@ -1,3 +1,5 @@
 ![Markdown Logo][image]
 
 [image]: /md.png
+
+![missing reference]

test/data/image_title.html

@@ -1 +1 @@
-<p><img alt="alt" src="/md.png" title="title" /></p>
+<p><img src="/md.png" alt="alt" title="title" /></p>

test/data/inline_link.html

@@ -1,4 +1,4 @@
-<p><a href="http://example.com">link</a> and <a href="/tests/">another link</a></p>
+<p><a href="http://example.com">link</a> and <a href="/url-with-(parentheses)">another link</a></p>
 <p><a href="http://example.com"><code>link</code></a></p>
-<p><a href="http://example.com"><img alt="MD Logo" src="http://parsedown.org/md.png" /></a></p>
+<p><a href="http://example.com"><img src="http://parsedown.org/md.png" alt="MD Logo" /></a></p>
-<p><a href="http://example.com"><img alt="MD Logo" src="http://parsedown.org/md.png" /> and text</a></p>
+<p><a href="http://example.com"><img src="http://parsedown.org/md.png" alt="MD Logo" /> and text</a></p>

test/data/inline_link.md

@@ -1,4 +1,4 @@
-[link](http://example.com) and [another link](/tests/)
+[link](http://example.com) and [another link](/url-with-(parentheses))
 
 [`link`](http://example.com)
 

test/data/inline_link_title.html

@@ -1 +1,4 @@
-<p><a href="http://example.com" title="Title">single quotes</a> and <a href="http://example.com" title="Title">double quotes</a></p>
+<p><a href="http://example.com" title="Title">single quotes</a></p>
+<p><a href="http://example.com" title="Title">double quotes</a></p>
+<p><a href="http://example.com" title="2 Words">space</a></p>
+<p><a href="http://example.com/url-(parentheses)" title="Title">parentheses</a></p>

test/data/inline_link_title.md

@@ -1 +1,7 @@
-[single quotes](http://example.com 'Title') and [double quotes](http://example.com "Title")
+[single quotes](http://example.com 'Title')
+
+[double quotes](http://example.com "Title")
+
+[space](http://example.com "2 Words")
+
+[parentheses](http://example.com/url-(parentheses) "Title")

test/data/sparse_html.html

@@ -0,0 +1,8 @@
+<div>
+line 1
+
+line 2
+line 3
+
+line 4
+</div>

test/data/sparse_html.md

@@ -0,0 +1,8 @@
+<div>
+line 1
+
+line 2
+line 3
+
+line 4
+</div>

test/data/special_characters.html

@@ -1,6 +1,6 @@
 <p>AT&amp;T has an ampersand in their name</p>
 <p>this &amp; that</p>
-<p>4 &lt; 5 and 6 > 5</p>
+<p>4 &lt; 5 and 6 &gt; 5</p>
 <p><a href="http://example.com/autolink?a=1&amp;b=2">http://example.com/autolink?a=1&amp;b=2</a></p>
 <p><a href="/script?a=1&amp;b=2">inline link</a></p>
 <p><a href="http://example.com/?a=1&amp;b=2">reference link</a></p>

test/data/table_inline_markdown.html

@@ -11,8 +11,8 @@
 <td><del>cell</del> 1.2</td>
 </tr>
 <tr>
-<td><code>cell</code> 2.1</td>
+<td><code>|</code> 2.1</td>
-<td>cell 2.2</td>
+<td>| 2.2</td>
 </tr>
 </tbody>
 </table>

test/data/table_inline_markdown.md

@@ -1,4 +1,4 @@
 | _header_ 1   | header 2     |
 | ------------ | ------------ |
 | _cell_ 1.1   | ~~cell~~ 1.2 |
-| `cell` 2.1   | cell 2.2     |
+| `|` 2.1      | \| 2.2       |