Class cebe\markdown\GithubMarkdown
Markdown parser for github flavored markdown.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$enableNewlines | boolean | Whether to interpret newlines as <br /> -tags. |
cebe\markdown\GithubMarkdown |
$html5 | boolean | Whether to format markup according to HTML5 spec. | cebe\markdown\Markdown |
$keepListStartNumber | bool | Enable support start attribute of ordered lists. |
cebe\markdown\block\ListTrait |
$maximumNestingLevel | integer | The maximum nesting level for language elements. | cebe\markdown\Parser |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$context | string | The current context the parser is in. | cebe\markdown\Parser |
$escapeCharacters | cebe\markdown\GithubMarkdown | ||
$inlineHtmlElements | array | HTML elements considered as inline elements. | cebe\markdown\block\HtmlTrait |
$references | array | A list of defined references in this document. | cebe\markdown\inline\LinkTrait |
$selfClosingHtmlElements | array | HTML elements known to be self-closing. | cebe\markdown\block\HtmlTrait |
Public Methods
Method | Description | Defined By |
---|---|---|
parse() | Parses the given text considering the full language. | cebe\markdown\Parser |
parseParagraph() | Parses a paragraph without block elements (block elements are ignored). | cebe\markdown\Parser |
Protected Methods
Property Details
Whether to interpret newlines as <br />
-tags.
This feature is useful for comments where newlines are often meant to be real new lines.
protected $escapeCharacters = ['\\', '`', '*', '_', '{', '}', '[', ']', '(', ')', '#', '+', '-', '.', '!', '<', '>', ':', '|']
Method Details
Consume lines for a paragraph
Allow headlines, lists and code to break paragraphs
protected void consumeParagraph ( $lines, $current ) | ||
$lines | ||
$current |
protected void renderText ( $text ) | ||
$text |