website·Indexed 37 days ago
https://commonmark.thephpleague.com/Documentation for the CommonMark PHP library, including guides for version 1.x and migration paths to 2.x. Covers basic usage, installation, security, and a wide array of extensions such as GitHub-Flavored Markdown, tables, footnotes, and task lists, as well as customization of block and inline parsing and rendering.
league/commonmark library is a robust and highly extensible Markdown parser for PHP. It is the only PHP library fully compatible with both the CommonMark and GitHub-Flavored Markdown (GFM) specifications. It features an extensible architecture that supports custom syntax and provides community integrations for various frameworks and CMSes.league/commonmark-ext* packages can now switch to the integrated features.league/commonmark-ext* packages can now use these features natively.SmartPunctExtension intelligently converts ASCII quotes, dashes, and ellipses to their Unicode equivalents during Markdown parsing. For example, standard double quotes (") are converted to curly quotes (“ ”), and double hyphens (--) are converted to en-dashes (–)."CommonMark is the PHP League's Markdown parser," she said. "It's super-configurable... you can even use additional extensions to expand its capabilities -- just like this one!"<!-- Results in HTML: -->
<p>“CommonMark is the PHP League’s Markdown parser,” she said. “It’s super-configurable… you can even use additional extensions to expand its capabilities – just like this one!”</p>
DisallowedRawHtmlExtension automatically filters specific HTML tags by replacing the leading < with the entity < to prevent undesirable side-effects from malicious input. This is a requirement of the GFM spec. The following tags are filtered: <title>, <textarea>, <style>, <xmp>, <iframe>, <noembed>, <noframes>, <script>, and <plaintext>. All other HTML tags remain untouched. Note that this extension is included by default when using the GFM extension.Cursor to examine text at the current position; if the parser can handle the text, it creates the corresponding AST element; otherwise, it aborts to allow other parsers to attempt processing. For simple delimiter-based inlines, the Delimiter Processing functionality can be used instead of a full inline parser.The DisallowedRawHtmlExtension automatically escapes specific HTML tags by replacing the leading < with the < entity. This prevents malicious users from introducing tags that cause undesirable side-effects, as required by the GFM spec. By default, the following tags are escaped: <title>, <textarea>, <style>, <xmp>, <iframe>, <noembed>, <noframes>, <script>, and `<plaintext>.
Note: This extension is included by default within the GFM extension.
Environment. When registering a custom renderer, you must specify which block or inline classes it is intended to handle.~~) to be rendered within HTML <del> tags. Note that this extension is included by default if you are using the GFM extension.Cursor class is a string wrapper that tracks the current parsing position. It provides optimized methods for character inspection, movement, and regex matching. It currently only supports UTF-8 (and ASCII) encoding. When creating custom block or inline parsers, a pre-configured Cursor is automatically provided, already set to the current position being parsed.use League\CommonMark\Parser\Cursor;
$cursor = new Cursor('Hello World!');SmartPunctExtension automatically converts ASCII quotes, dashes, and ellipses to their corresponding Unicode equivalents during Markdown parsing. For example, it converts standard double quotes (") to curly quotes (“ ”), double hyphens (--) to en-dashes (–), and triple dots (...) to ellipses (…).