Class yii\helpers\Markdown
继承 | yii\helpers\Markdown » yii\helpers\BaseMarkdown |
---|---|
可用版本自 | 2.0 |
源码 | https://github.com/yiichina/yii2/blob/api/framework/helpers/Markdown.php |
Markdown 类提供了将 markdown 转换为 HTML 的功能。
基本用法如下:
$myHtml = Markdown::process($myText); // use original markdown flavor
$myHtml = Markdown::process($myText, 'gfm'); // use github flavored markdown
$myHtml = Markdown::process($myText, 'extra'); // use markdown extra
您可以使用 $flavors 属性配置多种风格。
获取更多详情信息请参阅 Markdown library documentation。
注意:Markdown 库可以与 PHPDoc 注释一起使用,如果你同时使用它们的话。 PHP
opcache
确保 it does not strip comments。
公共属性
属性 | 类型 | 描述 | 被定义在 |
---|---|---|---|
$defaultFlavor | \yii\helpers\在没有显式指定时使用的 | Markdown 风格字符串。
默认风格设置为 original 。 |
yii\helpers\BaseMarkdown |
$flavors | array | 将标记风格名称映射到相应解析器类配置的映射。 | yii\helpers\BaseMarkdown |
公共方法
方法 | 描述 | 被定义在 |
---|---|---|
process() | 将 markdown 转变成 HTML。 | yii\helpers\BaseMarkdown |
processParagraph() | 将 markdown 转换为 HTML 但是只解析内联元素。 | yii\helpers\BaseMarkdown |