kirra/markdown-task-lists

在 cebe/markdown 解析器中支持 Github 的任务列表。

维护者

详细信息

github.com/kirra/markdown-task-lists

源代码

问题

安装: 786

依赖项: 0

建议者: 0

安全性: 0

星星: 2

关注者: 4

分支: 1

开放问题: 0

v1.0.1 2019-10-15 12:38 UTC

Requires

Requires (Dev)

MIT 3f5f8e5abc56a6a57dcda430cd2a238df784d391

This package is auto-updated.

Last update: 2024-09-15 23:27:18 UTC

README

Build Status Coverage Status

一个用于扩展 cebe/markdown 以支持 任务列表功能 的特性。

安装

使用此工具需要 PHP 7.1 或更高版本。

composer require kirra/markdown-task-lists

使用方法

要解析任务列表，您需要创建自己的解析器，并让它 use TaskListsTrait。

class MyParser extends \cebe\markdown\Markdown {
	use Kirra\Markdown\TaskListsTrait;
}

$parser = new MyParser();
$parser->parse("- [ ] Open"); // Will return a list with an open checkbox.

复选框之后的所有内容都将被解析为内联元素。因此，您仍然可以应用解析器支持的任何内联样式。

在您的解析器中使用

如果您构建了一个完全定制的解析器，请确保它包含 cebe\markdown\block\ListTrait，因为复选框只在列表中有效。