Класс yii\console\Markdown
| Наследование | yii\console\Markdown » cebe\markdown\Parser |
|---|---|
| Используемые трейты | cebe\markdown\block\FencedCodeTrait, cebe\markdown\inline\CodeTrait, cebe\markdown\inline\EmphStrongTrait, cebe\markdown\inline\StrikeoutTrait |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/console/Markdown.php |
Парсер Markdown, улучшенный для чтения в консольных средах.
Основан на cebe/markdown.
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $escapeCharacters | массив | Эти символы могут быть "экранированы". | yii\console\Markdown |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| renderCode() | Отображает блок кода | yii\console\Markdown |
| renderEmph() | Отображает выделенные элементы. | yii\console\Markdown |
| renderInlineCode() | Отображает инлайновый фрагмент кода `. |
yii\console\Markdown |
| renderParagraph() | Отображает абзац | yii\console\Markdown |
| renderStrike() | Отображает функцию зачеркивания. | yii\console\Markdown |
| renderStrong() | Отображает жирные элементы. | yii\console\Markdown |
Подробное описание свойств
$escapeCharacters защищенное свойство
Эти символы могут быть "экранированы". При использовании одного из них с обратной косой чертой, символ будет выведен без неё и не будет интерпретироваться как Markdown.
protected array $escapeCharacters = ['\\', '`', '*', '_', '~']
Подробное описание методов
renderCode() защищенный метод
Отображает блок кода
| защищенный строка renderCode ( $block ) | ||
|---|---|---|
| $block | массив | |
renderEmph() защищенный метод
Отображает выделенные элементы.
| защищенный строка renderEmph ( $element ) | ||
|---|---|---|
| $element | массив | |
renderInlineCode() защищенный метод
Отображает инлайновый фрагмент кода `.
| защищенный строка renderInlineCode ( $element ) | ||
|---|---|---|
| $element | массив | |
renderParagraph() защищенный метод
Отображает абзац
| защищенный строка renderParagraph ( $block ) | ||
|---|---|---|
| $block | строка | |
renderStrike() защищенный метод
Отображает функцию зачеркивания.
| защищенный строка renderStrike ( $element ) | ||
|---|---|---|
| $element | массив | |
renderStrong() защищенный метод
Отображает жирные элементы.
| защищенный строка renderStrong ( $element ) | ||
|---|---|---|
| $element | массив | |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-markdown.html
