Markdown.php 823 Bytes
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/**
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @link http://www.yiiframework.com/
 * @license http://www.yiiframework.com/license/
 */

namespace yii\helpers;

/**
 * Markdown provides an ability to transform markdown into HTML.
 *
 * Basic usage is the following:
 *
 * ```php
16
 * $myHtml = Markdown::process($myText);
17 18 19 20 21
 * ```
 *
 * If you want to configure the parser:
 *
 * ```php
Alexander Makarov committed
22
 * $myHtml = Markdown::process($myText, [
23
 *     'fn_id_prefix' => 'footnote_',
Alexander Makarov committed
24
 * ]);
25 26
 * ```
 *
Alexander Makarov committed
27 28
 * Note that in order to use this helper you need to install "michelf/php-markdown" Composer package.
 *
29 30 31 32
 * For more details please refer to [PHP Markdown library documentation](http://michelf.ca/projects/php-markdown/).
 * @author Alexander Makarov <sam@rmcreative.ru>
 * @since 2.0
 */
33
class Markdown extends BaseMarkdown
34 35
{
}