mirror of
https://github.com/erusev/parsedown.git
synced 2023-08-10 21:13:06 +03:00
Compare commits
90 Commits
Author | SHA1 | Date | |
---|---|---|---|
3ebbd730b5 | |||
1f02626ed6 | |||
fa005fdb95 | |||
5f40cab3e7 | |||
0e89e3714b | |||
6b24125f06 | |||
a589bcac79 | |||
a9dfc97ddc | |||
28774a4359 | |||
b8b5711ee5 | |||
9579e5f5e5 | |||
7f7f6418a3 | |||
ee81967749 | |||
96e0810188 | |||
99bd1bd678 | |||
e7a6a06166 | |||
eca5bb8262 | |||
1312908056 | |||
76b7d7babd | |||
ba802c1c8d | |||
438874e9a8 | |||
8e26f45dee | |||
e2bb3eaaf8 | |||
0de61e7b3a | |||
5b72dceb26 | |||
95699c9ba6 | |||
790066e9a7 | |||
b9e5228e92 | |||
31c8856f53 | |||
d5823ad622 | |||
6736ba9a04 | |||
468d1e3da8 | |||
7aa1d97bba | |||
f768f9c63f | |||
aa83968534 | |||
85eadccc05 | |||
c94fa12d67 | |||
11e02d45fa | |||
ecd53f9add | |||
844b2f49ea | |||
b2ad712644 | |||
65116c3cb0 | |||
147003107a | |||
618b26056c | |||
b828fe7c8d | |||
6c9df528aa | |||
cb8cc57742 | |||
9da19c1108 | |||
ffd9d3b407 | |||
e94ecf4adc | |||
4d3079b908 | |||
70e7a17380 | |||
9518c8e384 | |||
c581284231 | |||
cb1940255a | |||
93d0ec9397 | |||
9c6e7e880a | |||
2d62e29625 | |||
595f33871e | |||
97e1e0efaa | |||
648419467a | |||
6ddb6b2b33 | |||
0008e69a83 | |||
c664785485 | |||
bdf0ef024e | |||
21a3e8790a | |||
e5e8d02934 | |||
7ff0f97811 | |||
596350d1f5 | |||
2cbd3010e4 | |||
3b4aa6bff7 | |||
05a8f16e95 | |||
79d924040a | |||
b4a8eb3315 | |||
4383cce85b | |||
ada39109e4 | |||
a06cdfb814 | |||
6bee326c92 | |||
3fe867d294 | |||
f08d017bcb | |||
e61a6114b0 | |||
9ed72ccd09 | |||
09e1184d9f | |||
2de60a9a8b | |||
73a75299f5 | |||
0d28808392 | |||
78960cf792 | |||
8f2e9c7cf6 | |||
4b7d7cdef2 | |||
97e667ab30 |
10
.travis.yml
10
.travis.yml
@ -1,10 +1,16 @@
|
|||||||
language: php
|
language: php
|
||||||
|
|
||||||
php:
|
php:
|
||||||
|
- 7.0
|
||||||
- 5.6
|
- 5.6
|
||||||
- 5.5
|
- 5.5
|
||||||
- 5.4
|
- 5.4
|
||||||
- 5.3
|
- 5.3
|
||||||
- 5.2
|
|
||||||
- hhvm
|
- hhvm
|
||||||
|
- hhvm-nightly
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
fast_finish: true
|
||||||
|
allow_failures:
|
||||||
|
- php: 7.0
|
||||||
|
- php: hhvm-nightly
|
||||||
|
1048
Parsedown.php
1048
Parsedown.php
File diff suppressed because it is too large
Load Diff
39
README.md
39
README.md
@ -1,18 +1,22 @@
|
|||||||
## Parsedown
|
## Parsedown
|
||||||
|
|
||||||
|
[](https://travis-ci.org/erusev/parsedown)
|
||||||
|
<!--[](https://packagist.org/packages/erusev/parsedown)-->
|
||||||
|
|
||||||
Better Markdown Parser in PHP
|
Better Markdown Parser in PHP
|
||||||
|
|
||||||
[[ demo ]](http://parsedown.org/demo)
|
[Demo](http://parsedown.org/demo) |
|
||||||
|
[Benchmarks](http://parsedown.org/speed) |
|
||||||
|
[Tests](http://parsedown.org/tests/) |
|
||||||
|
[Documentation](https://github.com/erusev/parsedown/wiki/)
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
* [Fast](http://parsedown.org/speed)
|
* Super Fast
|
||||||
* [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
|
||||||
|
* Tested in 5.3 to 5.6
|
||||||
* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
|
* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
|
||||||
* [JavaScript port](https://github.com/hkdobrev/parsedown.js) under development
|
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
@ -26,21 +30,28 @@ $Parsedown = new Parsedown();
|
|||||||
echo $Parsedown->text('Hello _Parsedown_!'); # 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).
|
More examples in [the wiki](https://github.com/erusev/parsedown/wiki/) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
|
||||||
|
|
||||||
### Questions
|
### Questions
|
||||||
|
|
||||||
**How does Parsedown work?**<br/>
|
**How does Parsedown work?**
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
**Why doesn’t Parsedown use namespaces?**<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.
|
||||||
It'd mean no support for PHP 5.2. Would it be worth it?
|
|
||||||
|
|
||||||
**Is Parsedown compliant with CommonMark?**<br/>
|
**Is it compliant with CommonMark?**
|
||||||
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.
|
|
||||||
|
It passes most of the CommonMark tests. Most of the tests that don't pass deal with cases that are quite uncommon. Still, as CommonMark matures, compliance should improve.
|
||||||
|
|
||||||
|
**Who uses it?**
|
||||||
|
|
||||||
**Who uses Parsedown?**<br/>
|
|
||||||
[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).
|
[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?**<br/>
|
**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).
|
|
||||||
|
Use it, star it, share it and if you feel generous, [donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
You might also like [Caret](http://caret.io) - our Markdown editor for the desktop.
|
||||||
|
@ -136,4 +136,24 @@ EXPECTED_HTML;
|
|||||||
$parsedownWithNoMarkup->setMarkupEscaped(true);
|
$parsedownWithNoMarkup->setMarkupEscaped(true);
|
||||||
$this->assertEquals($expectedHtml, $parsedownWithNoMarkup->text($markdownWithHtml));
|
$this->assertEquals($expectedHtml, $parsedownWithNoMarkup->text($markdownWithHtml));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testLateStaticBinding()
|
||||||
|
{
|
||||||
|
include 'test/TestParsedown.php';
|
||||||
|
|
||||||
|
$parsedown = Parsedown::instance();
|
||||||
|
$this->assertInstanceOf('Parsedown', $parsedown);
|
||||||
|
|
||||||
|
// After instance is already called on Parsedown
|
||||||
|
// subsequent calls with the same arguments return the same instance
|
||||||
|
$sameParsedown = TestParsedown::instance();
|
||||||
|
$this->assertInstanceOf('Parsedown', $sameParsedown);
|
||||||
|
$this->assertSame($parsedown, $sameParsedown);
|
||||||
|
|
||||||
|
$testParsedown = TestParsedown::instance('test late static binding');
|
||||||
|
$this->assertInstanceOf('TestParsedown', $testParsedown);
|
||||||
|
|
||||||
|
$sameInstanceAgain = TestParsedown::instance('test late static binding');
|
||||||
|
$this->assertSame($testParsedown, $sameInstanceAgain);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
5
test/TestParsedown.php
Normal file
5
test/TestParsedown.php
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
class TestParsedown extends Parsedown
|
||||||
|
{
|
||||||
|
}
|
@ -1,21 +1,21 @@
|
|||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th align="left">header 1</th>
|
<th style="text-align: left;">header 1</th>
|
||||||
<th align="center">header 2</th>
|
<th style="text-align: center;">header 2</th>
|
||||||
<th align="right">header 2</th>
|
<th style="text-align: right;">header 2</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="left">cell 1.1</td>
|
<td style="text-align: left;">cell 1.1</td>
|
||||||
<td align="center">cell 1.2</td>
|
<td style="text-align: center;">cell 1.2</td>
|
||||||
<td align="right">cell 1.3</td>
|
<td style="text-align: right;">cell 1.3</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="left">cell 2.1</td>
|
<td style="text-align: left;">cell 2.1</td>
|
||||||
<td align="center">cell 2.2</td>
|
<td style="text-align: center;">cell 2.2</td>
|
||||||
<td align="right">cell 2.3</td>
|
<td style="text-align: right;">cell 2.3</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
@ -1,13 +1,12 @@
|
|||||||
<div>_content_</div>
|
<div>_content_</div>
|
||||||
<p>sparse:</p>
|
|
||||||
<div>
|
|
||||||
<div class="inner">
|
|
||||||
_content_
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<p>paragraph</p>
|
<p>paragraph</p>
|
||||||
|
<div>
|
||||||
|
<div class="inner">
|
||||||
|
_content_
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
p {
|
p {color: #789;}
|
||||||
color: red;
|
</style>
|
||||||
}
|
<div>
|
||||||
</style>
|
<a href="/">home</a></div>
|
@ -1,17 +1,16 @@
|
|||||||
<div>_content_</div>
|
<div>_content_</div>
|
||||||
|
|
||||||
sparse:
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<div class="inner">
|
|
||||||
_content_
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
paragraph
|
paragraph
|
||||||
|
|
||||||
|
<div>
|
||||||
|
<div class="inner">
|
||||||
|
_content_
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
p {
|
p {color: #789;}
|
||||||
color: red;
|
|
||||||
}
|
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
|
<div>
|
||||||
|
<a href="/">home</a></div>
|
@ -1 +1,2 @@
|
|||||||
<p><img src="/md.png" alt="alt" title="title" /></p>
|
<p><img src="/md.png" alt="alt" title="title" /></p>
|
||||||
|
<p><img src="/md.png" alt="blank title" title="" /></p>
|
@ -1 +1,3 @@
|
|||||||

|

|
||||||
|
|
||||||
|

|
@ -1,4 +1,6 @@
|
|||||||
<p><a href="http://example.com">link</a> and <a href="/tests/">another link</a></p>
|
<p><a href="http://example.com">link</a></p>
|
||||||
|
<p><a href="/url-(parentheses)">link</a> with parentheses in URL </p>
|
||||||
|
<p>(<a href="/index.php">link</a>) in parentheses</p>
|
||||||
<p><a href="http://example.com"><code>link</code></a></p>
|
<p><a href="http://example.com"><code>link</code></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 src="http://parsedown.org/md.png" alt="MD Logo" /></a></p>
|
||||||
<p><a href="http://example.com"><img src="http://parsedown.org/md.png" alt="MD Logo" /> and text</a></p>
|
<p><a href="http://example.com"><img src="http://parsedown.org/md.png" alt="MD Logo" /> and text</a></p>
|
@ -1,4 +1,8 @@
|
|||||||
[link](http://example.com) and [another link](/tests/)
|
[link](http://example.com)
|
||||||
|
|
||||||
|
[link](/url-(parentheses)) with parentheses in URL
|
||||||
|
|
||||||
|
([link](/index.php)) in parentheses
|
||||||
|
|
||||||
[`link`](http://example.com)
|
[`link`](http://example.com)
|
||||||
|
|
||||||
|
@ -1 +1,6 @@
|
|||||||
<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="">single quotes blank</a></p>
|
||||||
|
<p><a href="http://example.com" title="">double quotes blank</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>
|
@ -1 +1,11 @@
|
|||||||
[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")
|
||||||
|
|
||||||
|
[single quotes blank](http://example.com '')
|
||||||
|
|
||||||
|
[double quotes blank](http://example.com "")
|
||||||
|
|
||||||
|
[space](http://example.com "2 Words")
|
||||||
|
|
||||||
|
[parentheses](http://example.com/url-(parentheses) "Title")
|
@ -20,17 +20,17 @@
|
|||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th align="left">header 1</th>
|
<th style="text-align: left;">header 1</th>
|
||||||
<th>header 2</th>
|
<th>header 2</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="left">cell 1.1</td>
|
<td style="text-align: left;">cell 1.1</td>
|
||||||
<td>cell 1.2</td>
|
<td>cell 1.2</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="left">cell 2.1</td>
|
<td style="text-align: left;">cell 2.1</td>
|
||||||
<td>cell 2.2</td>
|
<td>cell 2.2</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -11,8 +11,12 @@
|
|||||||
<td><del>cell</del> 1.2</td>
|
<td><del>cell</del> 1.2</td>
|
||||||
</tr>
|
</tr>
|
||||||
<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>
|
||||||
|
<tr>
|
||||||
|
<td><code>\|</code> 2.1</td>
|
||||||
|
<td><a href="/">link</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
@ -1,4 +1,5 @@
|
|||||||
| _header_ 1 | header 2 |
|
| _header_ 1 | header 2 |
|
||||||
| ------------ | ------------ |
|
| ------------ | ------------ |
|
||||||
| _cell_ 1.1 | ~~cell~~ 1.2 |
|
| _cell_ 1.1 | ~~cell~~ 1.2 |
|
||||||
| `cell` 2.1 | cell 2.2 |
|
| `|` 2.1 | \| 2.2 |
|
||||||
|
| `\|` 2.1 | [link](/) |
|
Reference in New Issue
Block a user