erusev/parsedown


Better Markdown Parser in PHP

http://parsedown.org

License: MIT

Language: PHP

Keywords: markdown, markdown-parser, parser, php


Parsedown

Parsedown

Build Status Total Downloads Version License

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.

Project Statistics

Sourcerank 20
Repository Size 1.24 MB
Stars 12,025
Forks 915
Watchers 213
Open issues 76
Dependencies 3
Contributors 41
Tags 80
Created
Last updated
Last pushed

Top Contributors See all

Emanuil Rusev Aidan Woods Daniel Rudolf Haralan Dobrev naNuke Andy Miller Won Kyu Park Daniel Berthereau Carsten Brandt Gabriel Caruso Kane Cohen James Vickery Miguel Piedrafita Nathan Baulch Nathan Baulch Luiz Paulo "Bills" Václav Makeš Andrey Bolonin LNFWebsite tebe

Packages Referencing this Repo

erusev/parsedown
Parser for Markdown.
Latest release 1.8.0-beta-7 - Updated - 12K stars

Recent Tags See all

1.7.3 March 17, 2019
1.8.0-beta-7 March 17, 2019
v1.8.0-beta-6 March 17, 2019
v1.7.2 March 17, 2019
1.8.0-beta-6 March 17, 2019
1.7.2 March 17, 2019
1.8.0-beta-5 June 11, 2018
1.8.0-beta-4 May 08, 2018
1.8.0-beta-3 May 07, 2018
1.8.0-beta-2 May 07, 2018
1.8.0-beta-1 April 08, 2018
1.7.1 March 08, 2018
1.7.0 February 28, 2018
1.6.4 November 14, 2017
1.6.3 May 14, 2017

Interesting Forks See all

aidanwoods/parsedown
Markdown Parser in PHP
PHP - Last pushed - 4 stars
llato/parsedown
Better Markdown Parser in PHP
PHP - MIT - Updated - 1 stars
Zac-Garby/parsedown
Markdown Parser in PHP
PHP - Updated - 1 stars
Tony133/parsedown
Markdown Parser in PHP
This repository is no longer available - 1 stars
PHPCraftdream/parsedown
Better Markdown Parser in PHP
This repository is no longer available - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-11-14 04:16:30 UTC

Login to resync this repository