任务列表
Mr.Hope ... 2021-4-25 小于 1 分钟
让你的 VuePress 站点中的 Markdown 文件支持任务列表。
# 配置
module.exports = {
plugins: [
[
"md-enhance",
{
// 启用任务列表
tasklist: true,
},
],
],
};
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 语法
- 使用
- [ ] 一些文字
渲染一个未勾选的任务项 - 使用
- [x] 一些文字
渲染一个勾选了的任务项 (我们也支持大写的X
)
# 例子
- [ ] Plan A
- [x] Plan B
1
2
2
# 高级
除了在插件选项中设置 tasklist: true
之外,你还可以将对象作为选项传递给它。可用选项如下:
interface TaskListOptions {
/**
* 是否禁用 checkbox
*
* @default true
*/
disabled?: boolean;
/**
* 是否使用 `<label>` 来包裹文字
*
* @default true
*/
label?: boolean;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15