markdown-todo

Micro util for generating a gfm markdown todo item.

Install with npm

npm i markdown-todo --save

Usage

var mdtodo = require('markdown-todo');

mdtodo('this is a todo.');
//=> '- [ ] this is a todo'

mdtodo('this is a completed todo.', true);
//=> '- [x] this is a todo'

Related projects

• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
• markdown-toc: Generate a markdown TOC (table of contents) with Remarkable.
• markdown-utils: Micro-utils for creating markdown snippets.
• to-gfm-code-block: Generate a github-flavored-markdown fenced code block snippet.

Running tests

Install dev dependencies.

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb-cli on March 21, 2015.