GitHub - erusev/parsedown: Markdown Parser in PHP
source link: https://github.com/erusev/parsedown
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Parsedown
Better Markdown Parser in PHP - Demo.
Features
Installation
Install the composer package:
composer require erusev/parsedown
Or download the latest release and include Parsedown.php
Example
$Parsedown = new Parsedown();
echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>You can also parse inline markdown only:
echo $Parsedown->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!More examples in the wiki and in this video tutorial.
Security
Parsedown is capable of escaping user-input within the HTML that it generates. Additionally Parsedown will apply sanitisation to additional scripting vectors (such as scripting link destinations) that are introduced by the markdown syntax itself.
To tell Parsedown that it is processing untrusted user-input, use the following:
$Parsedown->setSafeMode(true);If instead, you wish to allow HTML within untrusted user-input, but still want output to be free from XSS it is recommended that you make use of a HTML sanitiser that allows HTML tags to be whitelisted, like HTML Purifier.
In both cases you should strongly consider employing defence-in-depth measures, like deploying a Content-Security-Policy (a browser security feature) so that your page is likely to be safe even if an attacker finds a vulnerability in one of the first lines of defence above.
Security of Parsedown Extensions
Safe mode does not necessarily yield safe results when using extensions to Parsedown. Extensions should be evaluated on their own to determine their specific safety against XSS.
Escaping HTML
WARNING: This method isn't safe from XSS!
If you wish to escape HTML in trusted input, you can use the following:
$Parsedown->setMarkupEscaped(true);Beware that this still allows users to insert unsafe scripting vectors, such as links like [xss](javascript:alert%281%29).
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?
Laravel Framework, Bolt CMS, Grav CMS, Herbie CMS, Kirby CMS, October CMS, Pico CMS, Statamic CMS, phpDocumentor, RaspberryPi.org, Symfony Demo and more.
How can I help?
Use it, star it, share it and if you feel generous, donate.
What else should I know?
I also make Nota — a writing app designed for Markdown files :)
Recommend
-
100
Fuzzing markdown parser written in Go with go-fuzz
-
71
README.md Marky Mark Marky Mark is a parser written in Swift that converts markdown into native views. The way it looks it highly customizable and the supported markdown syntax is easy to exten...
-
79
PHP Parser written in Go This project uses goyacc
-
71
goldmark A markdown parser written in Go. Easy to extend, standard compliant, well structured. goldmark is compliant to CommonMark 0.29. Motivation I need a markdown parser for...
-
15
If you were to ask any developer which document format is the most preferred right now, the answer would unequivocally be Markdown. Currently, Markdown is being used with GitHub, GitLab, Bitbucket, and more as a default document format for most...
-
11
xml_parser_create_ns() Function Related Articles ...
-
12
Markdownosaur Markdownosaur uses Apple's excellent and relatively new Swift Markdown...
-
6
-
16
Casualwriter ...
-
5
Are you looking for a simple and efficient way to render Markdown content in your React project? Look no further than Markdown Parser React! Markdown Parser React is a lightweight, flexible, and easy-to-...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK