jonathan-reichardt/markdown-task-lists

基于 kirra/markdown-task-lists 分支。支持在 cebe/markdown 解析器中实现 GitHub 的任务列表。

v1.0.4 2020-11-26 14:17 UTC

This package is auto-updated.

Last update: 2024-09-26 22:22:38 UTC


README

kirra/markdown-task-lists 分支进行修改,以实现一些小的变更。

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

安装

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

composer require jonathan-reichardt/markdown-task-lists

用法

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

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

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

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

在自己的解析器中使用

如果您构建了一个完全自定义的解析器,请确保它包含 cebe\markdown\block\ListTrait,因为复选框只能在列表中工作。