Inheritance | yii\console\Markdown » cebe\markdown\Parser |
---|---|
Uses Traits | cebe\markdown\block\FencedCodeTrait, cebe\markdown\inline\CodeTrait, cebe\markdown\inline\EmphStrongTrait, cebe\markdown\inline\StrikeoutTrait |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/console/Markdown.php |
A Markdown parser that enhances markdown for reading in console environments.
Based on cebe/markdown.
Property | Type | Description | Defined By |
---|---|---|---|
$escapeCharacters | array | These are "escapeable" characters. | yii\console\Markdown |
Method | Description | Defined By |
---|---|---|
renderCode() | Renders a code block | yii\console\Markdown |
renderEmph() | Renders empathized elements. | yii\console\Markdown |
renderInlineCode() | Renders an inline code span ` . | yii\console\Markdown |
renderParagraph() | Render a paragraph block | yii\console\Markdown |
renderStrike() | Renders the strike through feature. | yii\console\Markdown |
renderStrong() | Renders strong elements. | yii\console\Markdown |
These are "escapeable" characters. When using one of these prefixed with a backslash, the character will be outputted without the backslash and is not interpreted as markdown.
protected array $escapeCharacters = ['\\', '`', '*', '_', '~']
Renders a code block
protected string renderCode ( $block ) | ||
---|---|---|
$block | array |
Renders empathized elements.
protected string renderEmph ( $element ) | ||
---|---|---|
$element | array |
Renders an inline code span `
.
protected string renderInlineCode ( $element ) | ||
---|---|---|
$element | array |
Render a paragraph block
protected string renderParagraph ( $block ) | ||
---|---|---|
$block | string |
Renders the strike through feature.
protected string renderStrike ( $element ) | ||
---|---|---|
$element | array |
Renders strong elements.
protected string renderStrong ( $element ) | ||
---|---|---|
$element | array |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-markdown.html