Markdown

API reference › yii › helpers › Markdown

class	yii\helpers\Markdown
Extends	BaseMarkdown
Since	2.0
Source	framework/helpers/Markdown.php

Markdown provides an ability to transform markdown into HTML.

Basic usage is the following:

$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

You can configure multiple flavors using the $flavors property.

For more details please refer to the Markdown library documentation.

Note: The Markdown library works with PHPDoc annotations so if you use it together with PHP opcache make sure it does not strip comments.

Properties

Property	Type	Description	Defined by
$defaultFlavor static	string	The markdown flavor to use when none is specified explicitly. Default: 'original'.	BaseMarkdown
$flavors static	array	A map of markdown flavor names to corresponding parser class configurations. Default: ['original' => ['class' => 'cebe\markdown\Markdown', 'html5' => true], 'gfm' => ['class' => 'cebe\markdown\GithubMarkdown', 'html5' => true], 'gfm-comment' => ['class' => 'cebe\markdown\GithubMarkdown', 'html5' => true, 'enableNewlines' => true], 'extra' => ['class' => 'cebe\markdown\MarkdownExtra', 'html5' => true]].	BaseMarkdown

Methods

Method	Description	Defined by
process() static	Converts markdown into HTML.	BaseMarkdown
processParagraph() static	Converts markdown into HTML but only parses inline elements.	BaseMarkdown
getParser() protected static		BaseMarkdown