Class yii\apidoc\helpers\ApiMarkdown
| Inheritance | yii\apidoc\helpers\ApiMarkdown » cebe\markdown\GithubMarkdown |
|---|---|
| Uses Traits | yii\apidoc\helpers\ApiMarkdownTrait |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/ApiMarkdown.php |
A Markdown helper with support for class reference links.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $renderer | yii\apidoc\renderers\BaseRenderer | yii\apidoc\helpers\ApiMarkdown |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $renderingContext | yii\apidoc\helpers\ApiMarkdown |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| highlight() | Highlights code | yii\apidoc\helpers\ApiMarkdown |
| process() | Converts markdown into HTML | yii\apidoc\helpers\ApiMarkdown |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| parseApiLinks() | yii\apidoc\helpers\ApiMarkdownTrait | |
| renderApiLink() | Renders API link | yii\apidoc\helpers\ApiMarkdownTrait |
| renderBrokenApiLink() | Renders API link that is broken i.e. points nowhere | yii\apidoc\helpers\ApiMarkdownTrait |
| renderCode() | yii\apidoc\helpers\ApiMarkdown | |
| renderHeadline() | yii\apidoc\helpers\ApiMarkdown | |
| renderLink() | yii\apidoc\helpers\ApiMarkdown |
Property Details
Method Details
Highlights code
| string highlight( $code, $language ) | ||
| $code | string | Code to highlight |
| $language | string | Language of the code to highlight |
| return | string | HTML of highlighted code |
|---|---|---|
Converts markdown into HTML
| string process( $content, $context = null, $paragraph = false ) | ||
| $content | string | |
| $context | yii\apidoc\models\TypeDoc | |
| $paragraph | boolean | |
| void renderCode( $block ) | ||
| $block | ||
| void renderHeadline( $block ) | ||
| $block | ||
| void renderLink( $block ) | ||
| $block | ||