webuni / commonmark-table-extension
v2.1.0
2019-09-26 13:28 UTC
Requires
- php: ^7.1
- league/commonmark: ~0.19.3|^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.14
- phpstan/phpstan: ~0.11
- phpunit/phpunit: ^7.0|^8.0
- symfony/var-dumper: ^4.0
- vimeo/psalm: ^3.0
README
已弃用
此扩展已被弃用。现在,所有功能都已在 league/commonmark
1.3+ 中的 League\CommonMark\Extension\Table
命名空间中存在,因此您应升级到该版本并使用该捆绑扩展而不是此扩展。
概述
表格扩展为 CommonMark 文档添加了创建表格的能力。
安装
此项目可以通过 Composer 安装。
composer require league/commonmark-ext-table
使用
按常规配置您的 环境
,然后简单添加此包提供的 TableExtension
。
use League\CommonMark\Converter; use League\CommonMark\DocParser; use League\CommonMark\Environment; use League\CommonMark\HtmlRenderer; use League\CommonMark\Ext\Table\TableExtension; // Obtain a pre-configured Environment with all the standard CommonMark parsers/renderers ready-to-go $environment = Environment::createCommonMarkEnvironment(); // Add this extension $environment->addExtension(new TableExtension()); // Instantiate the converter engine and start converting some Markdown! $converter = new Converter(new DocParser($environment), new HtmlRenderer($environment)); echo $converter->convertToHtml('# Hello World!');
语法
此包完全兼容 GFM 风格的表格。
简单
代码
th | th(center) | th(right) ---|:----------:|----------: td | td | td
结果
<table> <thead> <tr> <th style="text-align: left">th</th> <th style="text-align: center">th(center)</th> <th style="text-align: right">th(right<)/th> </tr> </thead> <tbody> <tr> <td style="text-align: left">td</td> <td style="text-align: center">td</td> <td style="text-align: right">td</td> </tr> </tbody> </table>
高级
| header 1 | header 2 | header 2 | | :------- | :------: | -------: | | cell 1.1 | cell 1.2 | cell 1.3 | | cell 2.1 | cell 2.2 | cell 2.3 |
表格标题
header 1 | header 2 -------- | -------- cell 1.1 | cell 1.2 [Simple table]
代码
header 1 | header 2
-------- | --------
cell 1.1 | cell 1.2
[*Prototype* table][reference_table]
结果
<table> <caption id="reference_table"><em>Prototype</em> table</caption> <thead> <tr> <th>header 1</th> <th>header 2</th> </tr> </thead> <tbody> <tr> <td>cell 1.1</td> <td>cell 1.2</td> </tr> </tbody> </table> <table>
变更日志
有关最近更改的更多信息,请参阅 变更日志。
开发
您需要安装 php 或 docker 来开发此库。要列出所有可用命令,请运行
./run
安全
如果您发现任何与安全相关的问题,请通过电子邮件 [email protected] 而不是使用问题跟踪器。
致谢
许可
此库使用 MIT 许可证授权。有关更多信息,请参阅 许可证文件。