Project: syntax-tree/mdast-util-gfm-task-list-item

Package: mdast-util-gfm-task-list-item@1.0.1

  1. Dependents: 0
  2. mdast extension to parse and serialize GFM task list items
  1. util 147
  2. markdown 145
  3. utility 143
  4. unist 133
  5. mdast 90
  6. mdast-util 31
  7. gfm 20
  8. markup 19
  9. list 11
  10. check 11
  11. item 6
  12. task 4
  13. checkbox 4
  14. todo 2


Build Coverage Downloads Size Sponsors Backers Chat

mdast extensions to parse and serialize GFM task list items.


What is this?

This package contains extensions that add support for the task list item syntax enabled by GFM to mdast-util-from-markdown and mdast-util-to-markdown.

When to use this

These tools are all rather low-level. In most cases, you’d want to use remark-gfm with remark instead.

When you are working with syntax trees and want all of GFM, use mdast-util-gfm instead.

When working with mdast-util-from-markdown, you must combine this package with micromark-extension-gfm-task-list-item.

This utility does not handle how markdown is turned to HTML. That’s done by mdast-util-to-hast.


This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install mdast-util-gfm-task-list-item

In Deno with esm.sh:

import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'https://esm.sh/mdast-util-gfm-task-list-item@1'

In browsers with esm.sh:

<script type="module">
  import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'https://esm.sh/mdast-util-gfm-task-list-item@1?bundle'


Say our document example.md contains:

* [ ] To do
* [x] Done

1. Mixed…
2. [x] …messages

…and our module example.js looks as follows:

import fs from 'node:fs/promises'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {toMarkdown} from 'mdast-util-to-markdown'
import {gfmTaskListItem} from 'micromark-extension-gfm-task-list-item'
import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'mdast-util-gfm-task-list-item'

const doc = await fs.readFile('example.md')

const tree = fromMarkdown(doc, {
  extensions: [gfmTaskListItem],
  mdastExtensions: [gfmTaskListItemFromMarkdown]


const out = toMarkdown(tree, {extensions: [gfmTaskListItemToMarkdown]})


…now running node example.js yields (positional info removed for brevity):

 type: 'root',
 children: [
     type: 'list',
     ordered: false,
     start: null,
     spread: false,
     children: [
         type: 'listItem',
         spread: false,
         checked: false,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: 'To do'}]}
         type: 'listItem',
         spread: false,
         checked: true,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: 'Done'}]}
     type: 'list',
     ordered: true,
     start: 1,
     spread: false,
     children: [
         type: 'listItem',
         spread: false,
         checked: null,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: 'Mixed…'}]}
         type: 'listItem',
         spread: false,
         checked: true,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: '…messages'}]}
*   [ ] To do
*   [x] Done

1.  Mixed…
2.  [x] …messages


This package exports the identifiers gfmTaskListItemFromMarkdown and gfmTaskListItemToMarkdown. There is no default export.


Extension for mdast-util-from-markdown.


Extension for mdast-util-to-markdown.

Syntax tree

The following interfaces are added to mdast by this utility.


ListItem (GFM)

interface ListItemGfm <: ListItem {
  checked: boolean?

In GFM, a checked field can be present. It represents whether the item is done (when true), not done (when false), or indeterminate or not applicable (when null or not present).

Content model

ListContent (GFM)

type ListContentGfm = ListItemGfm


This package is fully typed with TypeScript. It does not export additional types.

The ListItemGfm node type is supported in @types/mdast by default.


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with mdast-util-from-markdown version 1+ and mdast-util-to-markdown version 1+.


See contributing.md in syntax-tree/.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.


MIT © Titus Wormer