README
micromark-extension-gfm-task-list-item
micromark extension to support GitHub flavored markdown (GFM) task list items.
Contents
- What is this?
- When to use this
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package is a micromark extension to add support for GFM task list items.
It matches how task list items work on github.com
.
When to use this
In many cases, when working with micromark, you’d want to use
micromark-extension-gfm
instead, which combines
this package with other GFM features.
When working with syntax trees, you’d want to combine this package with
mdast-util-gfm-task-list-item
(or
mdast-util-gfm
when using micromark-extension-gfm
).
These tools are all rather low-level.
In most cases, you’d instead want to use remark-gfm
with
remark.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install micromark-extension-gfm-task-list-item
In Deno with Skypack:
import {gfmTaskListItem, gfmTaskListItemHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-task-list-item@1?dts'
In browsers with Skypack:
<script type="module">
import {gfmTaskListItem, gfmTaskListItemHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-task-list-item@1?min'
</script>
Use
import {micromark} from 'micromark'
import {
gfmTaskListItem,
gfmTaskListItemHtml
} from 'micromark-extension-gfm-task-list-item'
const output = micromark('* [x] a\n* [ ] b', {
extensions: [gfmTaskListItem],
htmlExtensions: [gfmTaskListItemHtml]
})
console.log(output)
Yields:
<ul>
<li><input checked="" disabled="" type="checkbox"> a</li>
<li><input disabled="" type="checkbox"> b</li>
</ul>
API
This package exports the following identifiers: gfmTaskListItem
,
gfmTaskListItemHtml
.
There is no default export.
The export map supports the endorsed
development
condition.
Run node --conditions development module.js
to get instrumented dev code.
Without this condition, production code is loaded.
gfmTaskListItem
An extension for micromark to parse GFM task list items (can be passed in
extensions
).
gfmTaskListItemHtml
An extension to compile them to HTML (can be passed in htmlExtensions
).
Types
This package is fully typed with TypeScript. There are no additional exported types.
Compatibility
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.
Security
This package is safe.
Related
syntax-tree/mdast-util-gfm-task-list-item
— support GFM task list items in mdastsyntax-tree/mdast-util-gfm
— support GFM in mdastremarkjs/remark-gfm
— support GFM in remark
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.