Package Exports
- markdown-it-task-lists
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (markdown-it-task-lists) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
markdown-it-task-lists
A markdown-it plugin to create GitHub-style task lists
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-listsUsage
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 itemsBrowser 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 testLicense
ISC