054ba3c487
this should break urls that attempt to include a protocol, or port (these are absolute URLs and should have a whitelisted protocol for use) but URLs that are relative, or relative from the site root should be preserved (though characters non essential for the URL structure may be urlencoded) this approach has significant advantages over attempting to locate something like `javascript:alert(1)` or `javascript:alert(1)` (which are both valid) because browsers have been known to ignore ridiculous characters when encountered (meaning something like `jav\ta\0\0script:alert(1)` would be xss :( ). Instead of trying to chase down a way to interpret a URL to decide whether there is a protocol, this approach ensures that two essential characters needed to achieve a colon are encoded `:` (obviously) and `;` (from `:`). If these characters appear in a relative URL then they are equivalent to their URL encoded form and so this change will be non breaking for that case. |
||
|---|---|---|
| test | ||
| .travis.yml | ||
| LICENSE.txt | ||
| Parsedown.php | ||
| README.md | ||
| composer.json | ||
| phpunit.xml.dist | ||
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
- 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.
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.