1
0
mirror of https://github.com/erusev/parsedown.git synced 2023-08-10 21:13:06 +03:00
Better Markdown Parser in PHP https://parsedown.org
Go to file
2015-01-15 22:04:02 +02:00
test improve fix for #184 2015-01-15 21:32:18 +02:00
.travis.yml remove composer dependency 2014-04-26 01:09:28 +03:00
composer.json remove the extra trailing comma from composer.json 2013-07-11 00:33:44 +03:00
LICENSE.txt improve license 2013-07-24 01:38:38 +03:00
Parsedown.php resolve #189 2015-01-15 22:04:02 +02:00
phpunit.xml.dist improve extensibility of test case 2014-09-26 02:06:16 +03:00
README.md update readme 2015-01-15 18:28:11 +02:00

Parsedown

Better Markdown Parser in PHP

[ demo ]

Features

Installation

Include Parsedown.php or install the composer package.

Example

$Parsedown = new Parsedown();

echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>

More examples in the wiki and in this video tutorial.

Questions

How does Parsedown work?

It tries to read Markdown like a human. First, it looks at the lines. Its 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).

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.

Is Parsedown 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.

Who uses Parsedown?

phpDocumentor, October CMS, Bolt CMS, Kirby CMS, Grav CMS, Statamic CMS, RaspberryPi.org and more.

How can I help?

Use the project, tell friends about it and if you feel generous, donate some money.