• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

revin/markdown-it-task-lists: A markdown-it plugin to create GitHub-style task l ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

revin/markdown-it-task-lists

开源软件地址(OpenSource Url):

https://github.com/revin/markdown-it-task-lists

开源编程语言(OpenSource Language):

JavaScript 100.0%

开源软件介绍(OpenSource Introduction):

markdown-it-task-lists

A markdown-it plugin to create GitHub-style task lists

Greenkeeper badge Build Status Code Climate

What it does

  • Builds task/todo lists out of markdown lists with items starting with [ ] or [x].
  • Nothing else

Why is this useful?

When you have markdown documentation with checklists, rendering HTML checkboxes out of the list items looks nicer than the raw square brackets.

Installation

npm install markdown-it-task-lists

Usage

Use it the same as a normal markdown-it plugin:

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

The rendered checkboxes are disabled; to change this, pass a truthy value into the enabled property of the plugin options:

var parser = md().use(taskLists, {enabled: true});

If you'd like to wrap the rendered list items in a <label> element for UX purposes, pass a truthy value to the label property of the plugin options:

var parser = md().use(taskLists, {label: true});

To add the label after the checkbox pass a truthy value to labelAfter property:

var parser = md().use(taskLists, {label: true, labelAfter: true});

Note: This option does require the label option to be truthy.

The options can be combined, of course.

Browser Usage

If you use one of the versions of this module available in dist/ directly in a browser by including it with a <script> element, it will be available globally in window.markdownitTaskLists.

Tests

npm install
npm test

License

ISC




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap