5f40cab3e7
Fixes erusev/parsedown-extra#67. This introduces PHP 5.3+ late static binding to the Singleton pattern in Parsedown. It will return an instance of Parsedown which inherits the class which called the `instance()` method rather than always returning instance of just `Parsedown`. Tests are testing this feature with a test class which inherits from Parsedown. Notice that calling `instance()` with the default arguments after an instance of `Parsedown` was already created, it will return it even though it is from just an instance of `Parsedown`. So this is fixing the problem just partially. |
||
|---|---|---|
| test | ||
| .travis.yml | ||
| composer.json | ||
| LICENSE.txt | ||
| Parsedown.php | ||
| phpunit.xml.dist | ||
| README.md | ||
Parsedown
Better Markdown Parser in PHP
Demo | Benchmarks | Tests | Documentation
Features
- Super Fast
- GitHub flavored
- Extensible
- Tested in 5.3 to 5.6
- 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.
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 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 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, RaspberryPi.org and more.
How can I help?
Use it, star it, share it and if you feel generous, donate.