A markdown-it plugin to create GitHub-style task lists
- Builds task/todo lists out of markdown lists with items starting with
[ ]or[x]. - Nothing else
When you have markdown documentation with checklists, rendering HTML checkboxes out of the list items looks nicer than the raw square brackets.
npm install markdown-it-task-listsUse 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 itemsIf 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.
npm install npm testISC