@mdit/plugin-tasklist

提供任务列表支持的插件。

使用

import { tasklist } from "@mdit/plugin-tasklist";
import MarkdownIt from "markdown-it";

const mdIt = new MarkdownIt().use(tasklist, {
  // your options, optional
});

mdIt.render(`\
- [x] task 1
- [ ] task 2
`);

语法

• 使用 - [ ] 一些文字 渲染一个未勾选的任务项
• 使用 - [x] 一些文字 渲染一个勾选了的任务项 (我们也支持大写的 X)

选项

disabledboolean

默认值true

是否禁用 checkbox。

labelboolean

默认值true

是否使用 <label> 来包裹文字。

containerClassstring

默认值'task-list-container'

tasklist 容器的 class。

itemClassstring

默认值'task-list-item'

tasklist item 的 class。

labelClassstring

默认值'task-list-item-label'

tasklist item label 的 class。

checkboxClassstring

默认值'task-list-item-checkbox'

tasklist item checkbox 的 class。

示例

• 计划 A
• 计划 B

示例

- [ ] 计划 A
- [x] 计划 B