File: vendor/erusev/parsedown/README.md

> You might also like Caret - our Markdown editor for Mac / Windows / Linux.

Parsedown

<!---->

Better Markdown Parser in PHP

Demo | Benchmarks | Tests | Documentation

Features

• One File
• No Dependencies
• Super Fast
• Extensible
• GitHub flavored
• Tested in 5.3 to 7.1 and in HHVM
• Markdown Extra extension

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.

Security

Parsedown does not sanitize the HTML that it generates. When you deal with untrusted content (ex: user commnets) you should also use a HTML sanitizer like HTML Purifier.

Questions

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 starts with a - then perhaps it belongs 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 it compliant with CommonMark?

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?

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

How can I help?

Use it, star it, share it and if you feel generous, donate.