czukowski/markdown-tables

cebe/markdown的RST网格表格解析器

1.0.4 2016-10-26 13:24 UTC

This package is auto-updated.

Last update: 2024-09-06 09:27:52 UTC


README

此包为cebe的Markdown实现添加了对reStructuredText(RST)网格表格语法的支持。

其背后的动机是技术文档通常需要支持复杂表格,这些表格可以跨越行和列并包含块元素。RST的网格表格提供了这些功能,尽管它们在Markdown中的其他表格实现中更难输入。

当前实现是将Grid Tables解析器从最初用Python编写的Docutils模块移植过来。请注意,Docutils的范围远大于网格表格,我的意图不是复制所有内容。一个考虑的扩展是最终添加对简单表格语法的支持,尤其是当前代码结构使其相对容易实现。

安装

推荐通过运行composer来安装

composer require czukowski/markdown-tables "~1.0"

或者,您可以手动将以下内容添加到项目的composer.json文件的require部分,然后从命令行运行composer update

"czukowski/markdown-tables: "~1.0"

使用方法

此包提供了一种RSTTableBlockTrait,可以在扩展cebe原始Markdown解析器的类中使用。

或者,提供了三个扩展以方便使用(选择最适合的一个)

use Cz\Markdown;

$markdownWithRSTTables = new MarkdownWithRSTTables;
$githubMarkdownWithRSTTables = new GithubMarkdownWithRSTTables;
$markdownExtraWithRSTTables = new MarkdownExtraWithRSTTables;

有关更多信息,请参阅原始README文件

已知问题

如果表格看起来有问题,请确保事先设置正确的默认编码,例如

// Set default encoding to UTF-8.
mb_internal_encoding('UTF-8');

许可证

分发允许在MIT许可证下进行。有关详细信息,请参阅LICENSE.md。