Markdown

API reference › yii › console › Markdown

class	`yii\console\Markdown`
Extends	`cebe\markdown\Parser`
Uses traits	`cebe\markdown\block\FencedCodeTrait`, `cebe\markdown\inline\CodeTrait`, `cebe\markdown\inline\EmphStrongTrait`, `cebe\markdown\inline\StrikeoutTrait`
Since	2.0
Source	`framework/console/Markdown.php`

A Markdown parser that enhances markdown for reading in console environments.

Based on cebe/markdown.

Properties

Property	Type	Description	Defined by
`$escapeCharacters` protected	`array`	These are “escapeable” characters. Default: ['\\', '`', '*', '_', '~'].	`Markdown`

Methods

Method	Description	Defined by
`renderCode()` protected	Renders a code block.	`Markdown`
`renderEmph()` protected	Renders empathized elements.	`Markdown`
`renderInlineCode()` protected	Renders an inline code span `.	`Markdown`
`renderParagraph()` protected	Render a paragraph block.	`Markdown`
`renderStrike()` protected	Renders the strike through feature.	`Markdown`
`renderStrong()` protected	Renders strong elements.	`Markdown`

Property details

$escapeCharacters

protected array $escapeCharacters = ['\\', '`', '*', '_', '~']

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.

Method details

renderCode()

protected function renderCode(array $block): string

Renders a code block.

Parameters

Parameter	Type	Description
`$block`	`array`

Returns

string

renderEmph()

protected function renderEmph(array $element): string

Renders empathized elements.

Parameters

Parameter	Type	Description
`$element`	`array`

Returns

string

renderInlineCode()

protected function renderInlineCode(array $element): string

Renders an inline code span `.

Parameters

Parameter	Type	Description
`$element`	`array`

Returns

string

renderParagraph()

protected function renderParagraph(array $block): string

Render a paragraph block.

Parameters

Parameter	Type	Description
`$block`	`array`

Returns

string

renderStrike()

protected function renderStrike(array $element): string

Renders the strike through feature.

Parameters

Parameter	Type	Description
`$element`	`array`

Returns

string

renderStrong()

protected function renderStrong(array $element): string

Renders strong elements.

Parameters

Parameter	Type	Description
`$element`	`array`

Returns

string