Class yii\console\Markdown

All Classes | Properties | Methods
Inheritanceyii\console\Markdown » cebe\markdown\Parser
Uses Traitscebe\markdown\block\FencedCodeTrait, cebe\markdown\inline\CodeTrait, cebe\markdown\inline\EmphStrongTrait, cebe\markdown\inline\StrikeoutTrait
Available since version2.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.

Protected Properties

Hide inherited properties

Property Type Description Defined By
$escapeCharacters array These are "escapeable" characters. yii\console\Markdown

Protected Methods

Hide inherited methods

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

Property Details

Hide inherited properties

$escapeCharacters protected property

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 = [
    '\\',
    '`',
    '*',
    '_',
    '~',
]

Method Details

Hide inherited methods

renderCode() protected method

Renders a code block.

protected string renderCode ( $block )
$block array 

                protected function renderCode($block)
{
    return Console::ansiFormat($block['content'], [Console::NEGATIVE]) . "\n\n";
}
renderEmph() protected method

Renders empathized elements.

protected string renderEmph ( $element )
$element array 

                protected function renderEmph($element)
{
    return Console::ansiFormat($this->renderAbsy($element[1]), [Console::ITALIC]);
}
renderInlineCode() protected method

Renders an inline code span `.

protected string renderInlineCode ( $element )
$element array 

                protected function renderInlineCode($element)
{
    return Console::ansiFormat($element[1], [Console::UNDERLINE]);
}
renderParagraph() protected method

Render a paragraph block.

protected string renderParagraph ( $block )
$block string 

                protected function renderParagraph($block)
{
    return rtrim($this->renderAbsy($block['content'])) . "\n\n";
}
renderStrike() protected method

Renders the strike through feature.

protected string renderStrike ( $element )
$element array 

                protected function renderStrike($element)
{
    return Console::ansiFormat($this->parseInline($this->renderAbsy($element[1])), [Console::CROSSED_OUT]);
}
renderStrong() protected method

Renders strong elements.

protected string renderStrong ( $element )
$element array 

                protected function renderStrong($element)
{
    return Console::ansiFormat($this->renderAbsy($element[1]), [Console::BOLD]);
}