README

一个功能齐全的 PHP markdown 解析器。

• 移植自 chjj/marked，与 JavaScript 预览保持一致

• 支持 Github Flavoured Markdown

  • 单词中的多个下划线

  • URL 自动链接

  • 删除线

  • 代码块

  • 表格

• 高性能

需求

• PHP 5.3+

• Composer

安装

composer require "breeswish/php-marked"

使用

最小使用

echo \Breezewish\Marked\Marked::render('I am using __markdown__.');
// => <p>I am using <strong>markdown</strong>.</p>

示例：使用默认值设置选项

\Breezewish\Marked\Marked::setOptions(array(
    'gfm'          => true,
    'tables'       => true,
    'breaks'       => false,
    'pedantic'     => false,
    'sanitize'     => false,
    'smartLists'   => false,
    'smartypants'  => false,
    'langPrefix'   => 'lang-',
    'xhtml'        => false,
    'headerPrefix' => '',
    'highlight'    => null,
    'renderer'     => new \Breezewish\Marked\Renderer()
));

echo \Breezewish\Marked\Marked::render('I am using __markdown__.');

Marked::render(markdownString [,options])

markdownString

类型：string

要编译的 markdown 源字符串。

options

类型：array

选项的哈希值。也可以使用上面看到的 Marked::setOptions 方法设置。

基本选项

gfm

类型：boolean 默认：true

启用 GitHub flavored markdown。

tables

类型：boolean 默认：true

启用 GFM 表格。此选项需要 gfm 选项为 true。

breaks

类型：boolean 默认：false

启用 GFM 行断开。此选项需要 gfm 选项为 true。

pedantic

类型：boolean 默认：false

尽可能遵守 markdown.pl 的晦涩部分。不要修复任何原始 markdown 的错误或不良行为。

sanitize

类型：boolean 默认：false

清洗输出。忽略任何输入的 HTML。

smartLists

类型：boolean 默认：true

使用比原始 markdown 更智能的列表行为。最终可能成为默认值，而旧行为将移动到 pedantic。

smartypants

类型：boolean 默认：false

使用“智能”的排版标点符号，如引号和破折号。

langPrefix

类型：string 默认："lang-"

要附加到 <code> 的 className 的前缀。

xhtml

类型：boolean 默认：false

渲染 XHTML。

headerPrefix

类型：string 默认：""

要附加到标题的 id 属性的前缀。

测试

运行 phpunit。

许可证

MIT 许可证。