任务列表
它会做什么
- 构建 任务/待办事宜列表 在下限列表中,从项目开始
[ ]或者说[x]。 。 。 . - 没别的了
为什么这样有用?
当您有带有核对表的下标文档时, 渲染 HTML 复选框 列表项目外的外观比原始方括号要好.
安装
npm install markdown-it-task-lists
使用量
使用与普通的平减插件相同 :
var md = require('markdown-it');
var taskLists = require('markdown-it-task-lists');
var parser = md().use(taskLists);
var result = parser.render(...); // markdown string containing task list items
已制成的复选框已禁用; 要更改此选项, 请将真实值传递到
页:1 enabled 插件选项的属性 :
var parser = md().use(taskLists, {enabled: true});
如果您想将已提供的清单项目包成 <label> uX 的元素
,将一个真实值传递到 label 插件选项的属性 :
var parser = md().use(taskLists, {label: true});
在复选框传递一个真实值后添加标签 labelAfter 属性 :
var parser = md().use(taskLists, {label: true, labelAfter: true});
说明: 此选项需要 label 选项是真实的.
当然,这些选择可以合并.
浏览器使用
如果您使用此模块中可用的版本之一 dist/ 直接输入
包含其中的浏览器 <script> 元素,将可用
全球 window.markdownitTaskLists。 。 。 .
测试
npm install
npm test
许可证
公务员制度委员会