1
0
mirror of https://github.com/erusev/parsedown.git synced 2023-08-10 21:13:06 +03:00
parsedown/README.md
Emanuil Rusev 93f7b26427 imp
2014-09-14 01:14:40 +03:00

1.8 KiB
Raw Blame History

Parsedown

Better Markdown parser for 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 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 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, Bolt CMS, RaspberryPi.org and more.