# Markdown

> Markdown provides an ability to transform markdown into HTML.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [helpers](/docs/api/yii/helpers/index.md) › Markdown

| class | `yii\helpers\Markdown` |
| --- | --- |
| Extends | [`BaseMarkdown`](/docs/api/yii/helpers/basemarkdown/index.md) |
| Since | 2.0 |
| Source | [`framework/helpers/Markdown.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/helpers/Markdown.php#L32) |

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`](/docs/api/yii/helpers/basemarkdown/index.md#property-flavors) property.

For more details please refer to the [Markdown library documentation](https://github.com/cebe/markdown#readme).

> Note: The Markdown library works with PHPDoc annotations so if you use it together with
> PHP `opcache` make sure [it does not strip comments](https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.save-comments).

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-defaultFlavor"></span>[`$defaultFlavor`](/docs/api/yii/helpers/basemarkdown/index.md#property-defaultFlavor) static | `string` | The markdown flavor to use when none is specified explicitly. Default: `'original'`. | [`BaseMarkdown`](/docs/api/yii/helpers/basemarkdown/index.md) |
| <span id="property-flavors"></span>[`$flavors`](/docs/api/yii/helpers/basemarkdown/index.md#property-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`](/docs/api/yii/helpers/basemarkdown/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-process"></span>[`process()`](/docs/api/yii/helpers/basemarkdown/index.md#method-process) static | Converts markdown into HTML. | [`BaseMarkdown`](/docs/api/yii/helpers/basemarkdown/index.md) |
| <span id="method-processParagraph"></span>[`processParagraph()`](/docs/api/yii/helpers/basemarkdown/index.md#method-processParagraph) static | Converts markdown into HTML but only parses inline elements. | [`BaseMarkdown`](/docs/api/yii/helpers/basemarkdown/index.md) |
| <span id="method-getParser"></span>[`getParser()`](/docs/api/yii/helpers/basemarkdown/index.md#method-getParser) protected static |  | [`BaseMarkdown`](/docs/api/yii/helpers/basemarkdown/index.md) |