README

一个面向对象、完全可扩展的PHP 5.4及以上版本的CommonMark解析器。

需求

将库添加到您的Composer依赖项

composer require fluxbb/commonmark

然后，使用Composer安装库及其依赖项

composer install

use FluxBB\CommonMark\Parser;

$parser = new Parser();
$html = $parser->render('Markdown is **awesome**');

// <p>Markdown is <em>awesome</em></p>

默认情况下，解析器通过XHTML进行渲染。

基本用法：（输出结果到STDOUT）

bin/markdown /path/to/file.md

以下命令将结果保存到文件

bin/markdown /path/to/file.md > /path/to/file.html

或者使用管道（在Windows上不工作）

echo "Markdown is **awesome**" | bin/markdown

	--compress (-c)       Remove whitespace between HTML tags
	--lint (-l)           Syntax check only (lint)

您还可以使用单个phar文件

markdown.phar /path/to/file.md

如果您更喜欢将此命令全局访问，请下载markdown.phar并将其移动到您的PATH。

mv markdown.phar /usr/local/bin/markdown

安装或更新dev依赖项。

php composer.phar update --dev

并运行phpunit

MIT许可证

请随意分支此存储库并发送拉取请求。看看到目前为止谁做出了贡献。

向最初创建此库的Kazuyuki Hayashi (@kzykhys)表示衷心的感谢。