nicl / silex-markdown
Dragonfly markdown库的简单Silex包装器
1.1.0
2013-08-05 20:33 UTC
Requires
- dflydev/markdown: 1.0.*
- silex/silex: 1.*
Suggests
- twig/twig: enables parsing markdown right from the template using simple filter
This package is not auto-updated.
Last update: 2024-09-28 14:22:35 UTC
README
Silex的轻量级markdown服务提供商。使用Dragonfly markdown解析器。
安装
建议通过 Composer 安装。只需将以下内容添加到您的 composer.json
文件中
{
"minimum-stability": "dev",
"require": {
"nicl/silex-markdown": "1.0.*"
}
}
用法
要使用服务提供者,首先注册它
$app->register(new MarkdownServiceProvider());
然后您可以在Twig文件中使用markdown过滤器。例如
{{ '#Hello World'|markdown }}
此外,您还可以访问Markdown解析器本身。只需实例化它并按如下方式调用 transformMarkdown
方法
use dflydev\markdown\MarkdownParser;
$parser = new MarkdownParser();
$parser->transformMarkdown($txt);
配置
参数
-
markdown.factory: 创建
dflydev\markdown\IMarkdownParser
实例的服务名称,字符串。 -
markdown.parser: 要使用的内置解析器名称,字符串。 默认: markdown
可用选项
- markdown: 标准Markdown解析器
- extra: Markdown Extra解析器
服务
-
markdown: Markdown解析器,
dflydev\markdown\IMarkdownParser
的实例。如果定义了 markdown.factory,则将使用该服务来创建
IMarkdownParser
实例。否则,将检查 markdown.parser 并实例化相应的类。
测试
如果您想运行测试,您需要安装 PHPUnit。然后,从 silex-markdown 根目录运行
phpunit
(您可能需要根据您的配置调整phpunit命令和路径。)