micromark-extension-gfm-task-list-item

micromark extension to support GitHub flavored markdown task list items. This extension matches the GFM spec for the few things it defines and otherwise matches github.com.

This package provides the low-level modules for integrating with the micromark tokenizer and the micromark HTML compiler.

You probably shouldn’t use this package directly, but instead use mdast-util-gfm-task-list-item with mdast.

Install

npm:

npm install micromark-extension-gfm-task-list-item

API

html

syntax

Note: syntax is the default export of this module, html is available at micromark-extension-gfm-task-list-item/html.

Support task list items. The exports are extensions for the micromark parser (to tokenize checks; can be passed in extensions) and the default HTML compiler (to compile as <input> elements; can be passed in htmlExtensions).

Related

• remarkjs/remark — markdown processor powered by plugins
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• syntax-tree/mdast-util-gfm-task-list-item — mdast utility to support task lists
• syntax-tree/mdast-util-from-markdown — mdast parser using micromark to create mdast from markdown
• syntax-tree/mdast-util-to-markdown — mdast serializer to create markdown from mdast

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer