resolve #248

Ignore html comments as well with markupEscape option.

.gitignore

@@ -1,3 +0,0 @@
-.DS_Store
-.idea
-nbproject

.travis.yml

@@ -1,8 +1,10 @@
 language: php
 
 php:
+  - 5.6
   - 5.5
   - 5.4
   - 5.3
   - 5.2
-  - hhvm
+  - hhvm
+  

CONTRIBUTING.md

@@ -1,20 +0,0 @@
-Pull Requests
--------------
-
-Do create pull requests that:
-
-* resolve an issue
-* improve an existing feature or text
-
-Do not create pull requests that:
-
-* introduce a feature or text
-* change the interface
-* change the coding style
-
-If a pull request contains unrelated changes, they should be submitted as separate pull requests.
-
-License
--------
-
-By contributing to the project, you grant the creator of the project a perpetual, worldwide, irrevocable license to use, reproduce and distribute your contributions and derivative works. You also warrant that you are the sole owner of your contributions and that they are your original works of authorship.

README.md

@@ -1,20 +1,18 @@
 ## Parsedown
 
-Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
+Better Markdown Parser in PHP
 
-***
-
-[ [demo](http://parsedown.org/demo) ] [ [tests](http://parsedown.org/tests/) ]
-
-***
+[[ demo ]](http://parsedown.org/demo)
 
 ### Features
 
-* [fast](http://parsedown.org/speed)
-* [consistent](http://parsedown.org/consistency)
-* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
-* [tested](https://travis-ci.org/erusev/parsedown) in PHP 5.2, 5.3, 5.4, 5.5 and [hhvm](http://www.hhvm.com/)
-* friendly to international input
+* [Fast](http://parsedown.org/speed)
+* [Consistent](http://parsedown.org/consistency)
+* [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
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra) <sup>new</sup>
+* [JavaScript port](https://github.com/hkdobrev/parsedown.js) under development <sup>new</sup>
 
 ### Installation
 
@@ -22,10 +20,24 @@ Include `Parsedown.php` or install [the composer package](https://packagist.org/
 
 ### Example
 
-```php
-$text = 'Hello *Parsedown*!';
+``` php
+$Parsedown = new Parsedown();
 
-$result = Parsedown::instance()->parse($text);
-
-echo $result; # prints: <p>Hello <em>Parsedown</em>!</p>
+echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
 ```
+
+More examples in [the wiki](https://github.com/erusev/parsedown/wiki/Usage) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
+
+### Questions
+
+**How does Parsedown work?**<br/>
+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/>
+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 are [working on it](https://github.com/erusev/parsedown/tree/commonmark).
+
+**Who uses Parsedown?**<br/>
+[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).

phpunit.xml.dist

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit colors="true">
+<phpunit bootstrap="test/bootstrap.php" colors="true">
 	<testsuites>
 		<testsuite>
-			<file>tests/Test.php</file>
+			<file>test/ParsedownTest.php</file>
 		</testsuite>
 	</testsuites>
 </phpunit>

test/ParsedownTest.php

@@ -0,0 +1,139 @@
+<?php
+
+class ParsedownTest extends PHPUnit_Framework_TestCase
+{
+    final function __construct($name = null, array $data = array(), $dataName = '')
+    {
+        $this->dirs = $this->initDirs();
+        $this->Parsedown = $this->initParsedown();
+
+        parent::__construct($name, $data, $dataName);
+    }
+
+    private $dirs, $Parsedown;
+
+    /**
+     * @return array
+     */
+    protected function initDirs()
+    {
+        $dirs []= dirname(__FILE__).'/data/';
+
+        return $dirs;
+    }
+
+    /**
+     * @return Parsedown
+     */
+    protected function initParsedown()
+    {
+        $Parsedown = new Parsedown();
+
+        return $Parsedown;
+    }
+
+    /**
+     * @dataProvider data
+     * @param $test
+     * @param $dir
+     */
+    function test_($test, $dir)
+    {
+        $markdown = file_get_contents($dir . $test . '.md');
+
+        $expectedMarkup = file_get_contents($dir . $test . '.html');
+
+        $expectedMarkup = str_replace("\r\n", "\n", $expectedMarkup);
+        $expectedMarkup = str_replace("\r", "\n", $expectedMarkup);
+
+        $actualMarkup = $this->Parsedown->text($markdown);
+
+        $this->assertEquals($expectedMarkup, $actualMarkup);
+    }
+
+    function data()
+    {
+        $data = array();
+
+        foreach ($this->dirs as $dir)
+        {
+            $Folder = new DirectoryIterator($dir);
+
+            foreach ($Folder as $File)
+            {
+                /** @var $File DirectoryIterator */
+
+                if ( ! $File->isFile())
+                {
+                    continue;
+                }
+
+                $filename = $File->getFilename();
+
+                $extension = pathinfo($filename, PATHINFO_EXTENSION);
+
+                if ($extension !== 'md')
+                {
+                    continue;
+                }
+
+                $basename = $File->getBasename('.md');
+
+                if (file_exists($dir . $basename . '.html'))
+                {
+                    $data []= array($basename, $dir);
+                }
+            }
+        }
+
+        return $data;
+    }
+
+    public function test_no_markup()
+    {
+        $markdownWithHtml = <<<MARKDOWN_WITH_MARKUP
+<div>_content_</div>
+
+sparse:
+
+<div>
+<div class="inner">
+_content_
+</div>
+</div>
+
+paragraph
+
+<style type="text/css">
+    p {
+        color: red;
+    }
+</style>
+
+comment
+
+<!-- html comment -->
+MARKDOWN_WITH_MARKUP;
+
+        $expectedHtml = <<<EXPECTED_HTML
+<p>&lt;div><em>content</em>&lt;/div></p>
+<p>sparse:</p>
+<p>&lt;div>
+&lt;div class="inner">
+<em>content</em>
+&lt;/div>
+&lt;/div></p>
+<p>paragraph</p>
+<p>&lt;style type="text/css"></p>
+<pre><code>p {
+    color: red;
+}</code></pre>
+<p>&lt;/style></p>
+<p>comment</p>
+<p>&lt;!-- html comment --></p>
+EXPECTED_HTML;
+        $parsedownWithNoMarkup = new Parsedown();
+        $parsedownWithNoMarkup->setMarkupEscaped(true);
+        $this->assertEquals($expectedHtml, $parsedownWithNoMarkup->text($markdownWithHtml));
+    }
+}

test/bootstrap.php

@@ -0,0 +1,3 @@
+<?php
+
+include 'Parsedown.php';

test/data/aesthetic_table.html

@@ -0,0 +1,18 @@
+<table>
+<thead>
+<tr>
+<th>header 1</th>
+<th>header 2</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>cell 1.1</td>
+<td>cell 1.2</td>
+</tr>
+<tr>
+<td>cell 2.1</td>
+<td>cell 2.2</td>
+</tr>
+</tbody>
+</table>

test/data/aesthetic_table.md

@@ -0,0 +1,4 @@
+| header 1 | header 2 |
+| -------- | -------- |
+| cell 1.1 | cell 1.2 |
+| cell 2.1 | cell 2.2 |

test/data/aligned_table.html

@@ -0,0 +1,21 @@
+<table>
+<thead>
+<tr>
+<th align="left">header 1</th>
+<th align="center">header 2</th>
+<th align="right">header 2</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="left">cell 1.1</td>
+<td align="center">cell 1.2</td>
+<td align="right">cell 1.3</td>
+</tr>
+<tr>
+<td align="left">cell 2.1</td>
+<td align="center">cell 2.2</td>
+<td align="right">cell 2.3</td>
+</tr>
+</tbody>
+</table>

test/data/aligned_table.md

@@ -0,0 +1,4 @@
+| header 1 | header 2 | header 2 |
+| :------- | :------: | -------: |
+| cell 1.1 | cell 1.2 | cell 1.3 |
+| cell 2.1 | cell 2.2 | cell 2.3 |

test/data/atx_heading.html

@@ -1,8 +1,9 @@
-<h1>h1</h1>
-<h2>h2</h2>
-<h3>h3</h3>
-<h4>h4</h4>
-<h5>h5</h5>
-<h6>h6</h6>
-<h1>closed h1</h1>
+<h1>h1</h1>
+<h2>h2</h2>
+<h3>h3</h3>
+<h4>h4</h4>
+<h5>h5</h5>
+<h6>h6</h6>
+<h6>h6</h6>
+<h1>closed h1</h1>
 <p>#</p>

test/data/atx_heading.md

@@ -1,15 +1,17 @@
-# h1
-
-## h2
-
-### h3
-
-#### h4
-
-##### h5
-
-###### h6
-
-# closed h1 #
-
+# h1
+
+## h2
+
+### h3
+
+#### h4
+
+##### h5
+
+###### h6
+
+####### h6
+
+# closed h1 #
+
 #

test/data/block-level_html.html

@@ -0,0 +1,13 @@
+<div>_content_</div>
+<p>sparse:</p>
+<div>
+<div class="inner">
+_content_
+</div>
+</div>
+<p>paragraph</p>
+<style type="text/css">
+    p {
+        color: red;
+    }
+</style>

test/data/block-level_html.md

@@ -0,0 +1,17 @@
+<div>_content_</div>
+
+sparse:
+
+<div>
+<div class="inner">
+_content_
+</div>
+</div>
+
+paragraph
+
+<style type="text/css">
+    p {
+        color: red;
+    }
+</style>

test/data/code_block.html

@@ -1,8 +1,8 @@
-<pre><code>&lt;?php
-
-$message = 'Hello World!'; 
-echo $message;</code></pre>
-<hr />
-<pre><code>&gt; not a quote 
-- not a list item
+<pre><code>&lt;?php
+
+$message = 'Hello World!';
+echo $message;</code></pre>
+<hr />
+<pre><code>&gt; not a quote
+- not a list item
 [not a reference]: http://foo.com</code></pre>

test/data/code_block.md

@@ -0,0 +1,10 @@
+    <?php
+
+    $message = 'Hello World!';
+    echo $message;
+
+---
+
+    > not a quote
+    - not a list item
+    [not a reference]: http://foo.com

test/data/code_span.html

@@ -2,4 +2,5 @@
 <p><code>this is also a codespan</code> trailing text</p>
 <p><code>and look at this one!</code></p>
 <p>single backtick in a code span: <code>`</code></p>
-<p>backtick-delimited string in a code span: <code>`foo`</code></p>
+<p>backtick-delimited string in a code span: <code>`foo`</code></p>
+<p><code>sth `` sth</code></p>

test/data/code_span.md

@@ -6,4 +6,6 @@ a `code span`
 
 single backtick in a code span: `` ` ``
 
-backtick-delimited string in a code span: `` `foo` ``
+backtick-delimited string in a code span: `` `foo` ``
+
+`sth `` sth`

test/data/deeply_nested_list.html

@@ -3,16 +3,10 @@
 <ul>
 <li>li
 <ul>
-<li>li
-<ul>
 <li>li</li>
-</ul>
-</li>
 <li>li</li>
-</ul>
-</li>
+</ul></li>
 <li>li</li>
-</ul>
-</li>
+</ul></li>
 <li>li</li>
 </ul>

test/data/deeply_nested_list.md

@@ -1,7 +1,6 @@
 - li
-  - li
     - li
-      - li
+        - li
+        - li
     - li
-  - li
 - li

test/data/emphasis.html

@@ -1,8 +1,8 @@
-<p><em>underscore</em>, <em>asterisk</em>, <em>one two</em>, <em>three four</em>, <em>a</em>, <em>b</em></p>
-<p><strong>strong</strong> and <em>em</em> and <strong>strong</strong> and <em>em</em></p>
-<p><em>line
-line
-line</em></p>
-<p>this_is_not_an_emphasis</p>
-<p>an empty emphasis __ ** is not an emphasis</p>
+<p><em>underscore</em>, <em>asterisk</em>, <em>one two</em>, <em>three four</em>, <em>a</em>, <em>b</em></p>
+<p><strong>strong</strong> and <em>em</em> and <strong>strong</strong> and <em>em</em></p>
+<p><em>line
+line
+line</em></p>
+<p>this_is_not_an_emphasis</p>
+<p>an empty emphasis __ ** is not an emphasis</p>
 <p>*mixed *<em>double and</em> single asterisk** spans</p>

test/data/emphasis.md

@@ -1,13 +1,13 @@
-_underscore_, *asterisk*, _one two_, *three four*, _a_, *b*
-
-**strong** and *em* and **strong** and *em*
-
-_line
-line
-line_
-
-this_is_not_an_emphasis
-
-an empty emphasis __ ** is not an emphasis
-
+_underscore_, *asterisk*, _one two_, *three four*, _a_, *b*
+
+**strong** and *em* and **strong** and *em*
+
+_line
+line
+line_
+
+this_is_not_an_emphasis
+
+an empty emphasis __ ** is not an emphasis
+
 *mixed **double and* single asterisk** spans

test/data/escaping.html

@@ -1,4 +1,6 @@
 <p>escaped *emphasis*.</p>
 <p><code>escaped \*emphasis\* in a code span</code></p>
 <pre><code>escaped \*emphasis\* in a code block</code></pre>
-<p>\ ` * _ { } [ ] ( ) > # + - . !</p>
+<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

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

test/data/horizontal_rule.html

@@ -1,5 +1,5 @@
-<hr />
-<hr />
-<hr />
-<hr />
+<hr />
+<hr />
+<hr />
+<hr />
 <hr />

test/data/horizontal_rule.md

@@ -1,9 +1,9 @@
----
-
-- - -
-
-   - - -
-
-***
-
+---
+
+- - -
+
+   - - -
+
+***
+
 ___

test/data/html_comment.html

@@ -0,0 +1,5 @@
+<!-- single line -->
+<p>paragraph</p>
+<!-- 
+  multiline -->
+<p>paragraph</p>

test/data/html_comment.md

@@ -0,0 +1,8 @@
+<!-- single line -->
+
+paragraph
+
+<!-- 
+  multiline -->
+
+paragraph

test/data/implicit_reference.html

@@ -1,3 +1,4 @@
 <p>an <a href="http://example.com">implicit</a> reference link</p>
 <p>an <a href="http://example.com">implicit</a> reference link with an empty link definition</p>
+<p>an <a href="http://example.com">implicit</a> reference link followed by <a href="http://cnn.com">another</a></p>
 <p>an <a href="http://example.com" title="Example">explicit</a> reference link with a title</p>

test/data/implicit_reference.md

@@ -4,6 +4,10 @@ an [implicit] reference link
 
 an [implicit][] reference link with an empty link definition
 
+an [implicit][] reference link followed by [another][]
+
+[another]: http://cnn.com
+
 an [explicit][example] reference link with a title
 
 [example]: http://example.com "Example"

test/data/lazy_blockquote.html

@@ -1,4 +1,6 @@
 <blockquote>
 <p>quote
 the rest of it</p>
+<p>another paragraph
+the rest of it</p>
 </blockquote>

test/data/lazy_blockquote.md

@@ -0,0 +1,5 @@
+> quote
+the rest of it
+
+> another paragraph
+the rest of it

test/data/line_break.html

@@ -1,2 +1,2 @@
-<p>line<br />
+<p>line<br />
 line</p>

test/data/line_break.md

@@ -1,2 +1,2 @@
-line  
+line  
 line

test/data/reference_title.html

@@ -0,0 +1,2 @@
+<p><a href="http://example.com" title="example title">double quotes</a> and <a href="http://example.com" title="example title">single quotes</a> and <a href="http://example.com" title="example title">parentheses</a></p>
+<p>[invalid title]: <a href="http://example.com">http://example.com</a> example title</p>

test/data/reference_title.md

@@ -0,0 +1,6 @@
+[double quotes] and [single quotes] and [parentheses]
+
+[double quotes]: http://example.com "example title"
+[single quotes]: http://example.com 'example title'
+[parentheses]: http://example.com (example title)
+[invalid title]: http://example.com example title

test/data/self-closing_html.html

@@ -0,0 +1,12 @@
+<hr>
+<p>paragraph</p>
+<hr/>
+<p>paragraph</p>
+<hr />
+<p>paragraph</p>
+<hr class="foo" id="bar" />
+<p>paragraph</p>
+<hr class="foo" id="bar"/>
+<p>paragraph</p>
+<hr class="foo" id="bar" >
+<p>paragraph</p>

test/data/self-closing_html.md

@@ -0,0 +1,12 @@
+<hr>
+paragraph
+<hr/>
+paragraph
+<hr />
+paragraph
+<hr class="foo" id="bar" />
+paragraph
+<hr class="foo" id="bar"/>
+paragraph
+<hr class="foo" id="bar" >
+paragraph

test/data/separated_nested_list.html

@@ -0,0 +1,9 @@
+<ul>
+<li>
+<p>li</p>
+<ul>
+<li>li</li>
+<li>li</li>
+</ul>
+</li>
+</ul>

test/data/separated_nested_list.md

@@ -0,0 +1,4 @@
+- li
+
+    - li
+    - li

test/data/setext_header.html

@@ -1,5 +1,5 @@
-<h1>h1</h1>
-<h2>h2</h2>
-<h2>single character</h2>
-<p>not a header</p>
+<h1>h1</h1>
+<h2>h2</h2>
+<h2>single character</h2>
+<p>not a header</p>
 <hr />

test/data/setext_header.md

@@ -1,12 +1,12 @@
-h1
-==
-
-h2
---
-
-single character
--
-
-not a header
-
+h1
+==
+
+h2
+--
+
+single character
+-
+
+not a header
+
 ------------

test/data/simple_table.html

@@ -0,0 +1,37 @@
+<table>
+<thead>
+<tr>
+<th>header 1</th>
+<th>header 2</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>cell 1.1</td>
+<td>cell 1.2</td>
+</tr>
+<tr>
+<td>cell 2.1</td>
+<td>cell 2.2</td>
+</tr>
+</tbody>
+</table>
+<hr />
+<table>
+<thead>
+<tr>
+<th align="left">header 1</th>
+<th>header 2</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="left">cell 1.1</td>
+<td>cell 1.2</td>
+</tr>
+<tr>
+<td align="left">cell 2.1</td>
+<td>cell 2.2</td>
+</tr>
+</tbody>
+</table>

test/data/simple_table.md

@@ -0,0 +1,11 @@
+header 1 | header 2
+-------- | --------
+cell 1.1 | cell 1.2
+cell 2.1 | cell 2.2
+
+---
+
+header 1 | header 2
+:------- | --------
+cell 1.1 | cell 1.2
+cell 2.1 | cell 2.2

test/data/span-level_html.html

@@ -0,0 +1,5 @@
+<p>an <b>important</b> <a href=''>link</a></p>
+<p>broken<br/>
+line</p>
+<p><b>inline tag</b> at the beginning</p>
+<p><span><a href="http://example.com">http://example.com</a></span></p>

test/data/span-level_html.md

@@ -0,0 +1,8 @@
+an <b>important</b> <a href=''>link</a>
+
+broken<br/>
+line
+
+<b>inline tag</b> at the beginning
+
+<span>http://example.com</span>

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><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>AT&amp;T has an ampersand in their name</p>
+<p>this &amp; that</p>
+<p>4 &lt; 5 and 6 > 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/special_characters.md

@@ -1,13 +1,13 @@
-AT&T has an ampersand in their name
-
-this & that
-
-4 < 5 and 6 > 5
-
-<http://example.com/autolink?a=1&b=2>
-
-[inline link](/script?a=1&b=2)
-
-[reference link][1]
-
+AT&T has an ampersand in their name
+
+this & that
+
+4 < 5 and 6 > 5
+
+<http://example.com/autolink?a=1&b=2>
+
+[inline link](/script?a=1&b=2)
+
+[reference link][1]
+
 [1]: http://example.com/?a=1&b=2

test/data/tab-indented_code_block.html

@@ -1,6 +1,6 @@
 <pre><code>&lt;?php
 
-$message = 'Hello World!'; 
+$message = 'Hello World!';
 echo $message;
 
 echo "following a blank line";</code></pre>

test/data/tab-indented_code_block.md

@@ -1,6 +1,6 @@
 	<?php
 	
-	$message = 'Hello World!'; 
+	$message = 'Hello World!';
 	echo $message;
 
 	echo "following a blank line";