icanboogie / render-engine-markdown
为 icanboogie/render 提供的 Markdown 渲染引擎。
v0.3.0
2022-04-17 15:56 UTC
Requires
- php: >=7.2
- erusev/parsedown: ^1.6
- icanboogie/render: ^0.7|^0.8
Requires (Dev)
- icanboogie/bind-render: ^5.0
- phpunit/phpunit: ^8.5
README
为 ICanBoogie/Render 提供的 Markdown 渲染引擎。
如果您与 ICanBoogie 一起使用此包,则引擎将自动注册。
安装
安装此包的推荐方式是通过 Composer
$ composer require icanboogie/render-engine-markdown
克隆仓库
该包可在 GitHub 上找到,其仓库可以通过以下命令行克隆:
$ git clone https://github.com/ICanBoogie/render-engine-markdown.git
文档
该包作为 ICanBoogie 框架的一部分进行文档编制 文档。您可以使用 make doc
命令为包及其依赖项生成文档。文档生成在 build/docs
目录中。需要 ApiGen。可以使用 make clean
命令清理该目录。
测试
使用 make test
命令运行测试套件。需要全局可用 PHPUnit 和 Composer 来运行套件。该命令将根据需要安装依赖项。使用 make test-coverage
命令运行测试套件,并在 "build/coverage" 中创建 HTML 覆盖率报告。可以使用 make clean
命令清理该目录。
该包由 Travis CI 持续测试。
许可
icanboogie/render-engine-markdown 依据新BSD许可证授权 - 详细信息请参阅 LICENSE 文件。