micromark-extension-gfm-task-list-item

What is micromark-extension-gfm-task-list-item?

The micromark-extension-gfm-task-list-item package is an extension for micromark that adds support for GitHub Flavored Markdown (GFM) task list items. This allows you to parse and render task lists in markdown documents.

What are micromark-extension-gfm-task-list-item's main functionalities?

Parse GFM Task List Items

This feature allows you to parse GFM task list items from markdown input. The code sample demonstrates how to use the micromark-extension-gfm-task-list-item extension to parse a markdown string containing task list items.

const micromark = require('micromark');
const gfmTaskListItem = require('micromark-extension-gfm-task-list-item');

const input = '- [ ] Task 1\n- [x] Task 2';
const output = micromark(input, { extensions: [gfmTaskListItem()] });
console.log(output);

Render GFM Task List Items

This feature allows you to render GFM task list items to HTML. The code sample demonstrates how to use the micromark-extension-gfm-task-list-item extension along with its HTML renderer to convert a markdown string containing task list items into HTML.

const micromark = require('micromark');
const gfmTaskListItem = require('micromark-extension-gfm-task-list-item');
const html = require('micromark-extension-gfm-task-list-item/html');

const input = '- [ ] Task 1\n- [x] Task 2';
const output = micromark(input, { extensions: [gfmTaskListItem()], htmlExtensions: [html()] });
console.log(output);

Other packages similar to micromark-extension-gfm-task-list-item

remark-gfm

remark-gfm is a plugin for remark that adds support for GitHub Flavored Markdown (GFM), including task lists. It is similar to micromark-extension-gfm-task-list-item but is used within the remark ecosystem, which is another popular markdown processor.

markdown-it-task-lists

markdown-it-task-lists is a plugin for markdown-it that adds support for GFM task lists. It provides similar functionality to micromark-extension-gfm-task-list-item but is designed to work with the markdown-it parser.

markdown-it-checkbox

markdown-it-checkbox is another plugin for markdown-it that adds support for checkboxes in markdown, which can be used to create task lists. It offers similar functionality to micromark-extension-gfm-task-list-item but focuses specifically on checkboxes.

README

micromark-extension-gfm-task-list-item

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

When to use this

You should probably use micromark-extension-gfm instead, which combines this package with other GFM features. Alternatively, if you don’t want all of GFM, use this package.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

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

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

gfmTaskListItemHtml

Support task list items. An extension for micromark to parse checks (can be passed in extensions) and one to compile as <input> elements (can be passed in htmlExtensions).

Related

• remarkjs/remark — markdown processor powered by plugins
• remarkjs/remark-gfm — remark plugin using this and other GFM features
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-gfm — micromark extension combining this with other GFM features
• syntax-tree/mdast-util-gfm-task-list-item — mdast utility to support task lists
• syntax-tree/mdast-util-gfm — mdast utility to support GFM
• 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