CommonMark

Introduction

This extension provides access to the reference implementation of CommonMark, a rationalized version of Markdown syntax with a specification.

Parsing:

The CommonMark extension provides a simple parsing API:

function CommonMark\Parse(string $content, int $options = ?): CommonMark\Node

Rendering:

The CommonMark extension provides simple rendering API that supports multiple formats:

function CommonMark\Render(CommonMark\Node $node, int $options = ?, int $width = ?): string

function CommonMark\Render\HTML(CommonMark\Node $node, int $options = ?): string

function CommonMark\Render\XML(CommonMark\Node $node, int $options = ?): string

function CommonMark\Render\Man(CommonMark\Node $node, int $options = ?, int $width = ?): string

function CommonMark\Render\Latex(CommonMark\Node $node, int $options = ?, int $width = ?): string

AST:

The CommonMark extension implements visitation for CommonMark\Node objects:

public function CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor): void

CQL:

The CommonMark extension provides an interface to CQL, CommonMark Query Language:

public function CommonMark\CQL::__construct(string $query)

Installing/Configuring
- Requirements
- Installation
Predefined Constants
CommonMark\Node\Document — Document concrete CommonMark\Node
CommonMark\Node\Heading — Heading concrete CommonMark\Node
- CommonMark\Node\Heading::__construct — Heading Construction
CommonMark\Node\Paragraph — Paragraph concrete CommonMark\Node
CommonMark\Node\BlockQuote — BlockQuote concrete CommonMark\Node
CommonMark\Node\BulletList — BulletList concrete CommonMark\Node
- CommonMark\Node\BulletList::__construct — BulletList Construction
CommonMark\Node\OrderedList — OrderedList concrete CommonMark\Node
- CommonMark\Node\OrderedList::__construct — OrderedList Construction
CommonMark\Node\Item — Item concrete CommonMark\Node
CommonMark\Node\Text — Text concrete CommonMark\Node
- CommonMark\Node\Text::__construct — Text Construction
CommonMark\Node\Text\Strong — Strong concrete CommonMark\Node
CommonMark\Node\Text\Emphasis — Emphasis concrete CommonMark\Node
CommonMark\Node\ThematicBreak — ThematicBreak concrete CommonMark\Node
CommonMark\Node\SoftBreak — SoftBreak concrete CommonMark\Node
CommonMark\Node\LineBreak — LineBreak concrete CommonMark\Node
CommonMark\Node\Code — Code concrete CommonMark\Node
CommonMark\Node\CodeBlock — CodeBlock concrete CommonMark\Node
- CommonMark\Node\CodeBlock::__construct — CodeBlock Construction
CommonMark\Node\HTMLBlock — HTMLBlock concrete CommonMark\Node
CommonMark\Node\HTMLInline — HTMLInline concrete CommonMark\Node
CommonMark\Node\Image — Image concrete CommonMark\Node
- CommonMark\Node\Image::__construct — Image Construction
CommonMark\Node\Link — Link concrete CommonMark\Node
- CommonMark\Node\Link::__construct — Link Construction
CommonMark\Node\CustomBlock — CustomBlock concrete CommonMark\Node
CommonMark\Node\CustomInline — CustomInline concrete CommonMark\Node
CommonMark\Node — Abstract CommonMark\Node
- CommonMark\Node::appendChild — AST Manipulation
- CommonMark\Node::prependChild — AST Manipulation
- CommonMark\Node::insertAfter — AST Manipulation
- CommonMark\Node::insertBefore — AST Manipulation
- CommonMark\Node::replace — AST Manipulation
- CommonMark\Node::unlink — AST Manipulation
- CommonMark\Node::accept — Visitation
CommonMark\Interfaces\IVisitor — The CommonMark\Interfaces\IVisitor interface
- CommonMark\Interfaces\IVisitor::enter — Visitation
- CommonMark\Interfaces\IVisitor::leave — Visitation
CommonMark\Interfaces\IVisitable — The CommonMark\Interfaces\IVisitable interface
- CommonMark\Interfaces\IVisitable::accept — Visitation
CommonMark\Parser — The CommonMark\Parser class
- CommonMark\Parser::__construct — Parsing
- CommonMark\Parser::parse — Parsing
- CommonMark\Parser::finish — Parsing
CommonMark\CQL — The CommonMark\CQL class
- CommonMark\CQL::__construct — CQL Construction
- CommonMark\CQL::__invoke — CQL Execution
CommonMark Functions
- CommonMark\Parse — Parsing
- CommonMark\Render — Rendering
- CommonMark\Render\HTML — Rendering
- CommonMark\Render\Latex — Rendering
- CommonMark\Render\Man — Rendering
- CommonMark\Render\XML — Rendering