parsedown README

The project's README from github.com/erusev/parsedown. As one markdown file: README.md.

Parsedown

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.

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 is not 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, ex: [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, sponsor me.

What else should I know?

I also make Nota — a notes app designed for local Markdown files.

parsedown (erusev/parsedown)

Searching Database…

15K ·GitHub
Parsedown
Что это такое?Parsedown — это PHP-библиотека для разбора Markdown: вы подаёте ей текст в формате Markdown, а она преобразует его в HTML.
Это библиотека, которую я вызываю из своего PHP-кода, или приложение, которое я запускаю?Это библиотека: вы подключаете её в PHP-проект и вызываете там, где коду нужно превратить Markdown в HTML — никакого интерфейса или отдельного приложения запускать не нужно.
Как использовать её в своём коде?Вы создаёте экземпляр Parsedown и вызываете его метод text(), передав строку с Markdown; он возвращает готовый HTML. Это базовый пример использования из README.
Можно ли безопасно рендерить Markdown, который отправляют посетители моего сайта?Из коробки — нет: в README прямо предупреждается, что метод по умолчанию не защищён от XSS. Безопасный режим экранирует HTML, но README оговаривает, что он всё равно допускает потенциально опасные векторы для скриптов.
Кто использует её в реальных проектах?Она широко распространена: её используют Laravel Framework, Bolt CMS, Grav CMS, Kirby CMS, October CMS, Pico CMS, Statamic CMS, phpDocumentor, RaspberryPi.org и Symfony Demo.
Проходит ли она тесты CommonMark?В основном да: Parsedown проходит большую часть тестов CommonMark, а те, что не проходит, касаются редких случаев. Автор ожидает, что соответствие спецификации будет расти по мере её развития.
Чем Parsedown разбирает Markdown иначе, чем другие парсеры?Он читает Markdown как человек: по началу строки определяются блоки (строка, начинающаяся с -, может быть частью списка), затем он следит за специальными символами, чтобы найти строчные элементы. Автор называет это подходом 'line based' и говорит, что это был первый парсер с таким подходом, а остальные — в PHP и за его пределами — последовали его примеру.
Что ещё создал автор?Автор также делает Nota — приложение для заметок, рассчитанное на локальные файлы Markdown.
What are similar projects?marked, markdown-it, nom, lexer, liteparse, PHP-Parser, turndown, go
Which topics is it in?commonmark, parsing, text-processing, cms, parser, php, developers, backend, html, markdown, web-development, free
Creator
erusev
Size
1.5 MB
Stars
15K
Updated
CommitFeb 18Release1.8.0Feb 16
Age
13y
Commits · 90 Days