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-05 15:05:18 +02:00
test resolve #251 2014-12-16 13:58:33 +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 improve names of protected members 2015-01-05 15:05:18 +02:00
phpunit.xml.dist improve extensibility of test case 2014-09-26 02:06:16 +03:00
README.md improve readme 2015-01-05 14:18:36 +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?
Parsedown 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).

Why doesnt Parsedown use namespaces?
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?
We are working on it.

Who uses Parsedown?
phpDocumentor, October CMS, Bolt CMS, Kirby CMS, RaspberryPi.org and more.

How can I help?
Use the project, tell friends about it and if you feel generous, donate some money.