mdast-util-gfm

mdast extensions to parse and serialize GFM (autolink literals, footnotes, strikethrough, tables, tasklists).

Contents

• What is this?
• When to use this
• Install
• Use
• API
  • gfmFromMarkdown()
  • gfmToMarkdown(options?)
  • Options
• HTML
• Syntax
• Syntax tree
• Types
• Compatibility
• Related
• Contribute
• License

What is this?

This package contains two extensions that add support for GFM syntax in markdown to mdast: autolink literals (www.x.com), footnotes ([^1]), strikethrough (~~stuff~~), tables (| cell |…), and tasklists (* [x]). These extensions plug into mdast-util-from-markdown (to support parsing GFM in markdown into a syntax tree) and mdast-util-to-markdown (to support serializing GFM in syntax trees to markdown).

When to use this

This project is useful when you want to support the same features that GitHub does in files in a repo, Gists, and several other places. Users frequently believe that some of these extensions, specifically autolink literals and tables, are part of normal markdown, so using mdast-util-gfm will help match your implementation to their understanding of markdown. There are several edge cases where GitHub’s implementation works in unexpected ways or even different than described in their spec, so writing in GFM is not always the best choice.

You can use these extensions when you are working with mdast-util-from-markdown and mdast-util-to-markdown already.

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

Instead of this package, you can also use the extensions separately:

• mdast-util-gfm-autolink-literal — support GFM autolink literals
• mdast-util-gfm-footnote — support GFM footnotes
• mdast-util-gfm-strikethrough — support GFM strikethrough
• mdast-util-gfm-table — support GFM tables
• mdast-util-gfm-task-list-item — support GFM tasklists

A different utility, mdast-util-frontmatter, adds support for frontmatter. GitHub supports YAML frontmatter for files in repos and Gists but they don’t treat it as part of GFM.

All these packages are used in remark-gfm, which focusses on making it easier to transform content by abstracting these internals away.

This utility does not handle how markdown is turned to HTML. That’s done by mdast-util-to-hast. If your content is not in English, you should configure that utility.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

1npm install mdast-util-gfm

In Deno with esm.sh:

1import {gfmFromMarkdown, gfmToMarkdown} from 'https://esm.sh/mdast-util-gfm@3'

In browsers with esm.sh:

1<script type="module">
2  import {gfmFromMarkdown, gfmToMarkdown} from 'https://esm.sh/mdast-util-gfm@3?bundle'
3</script>

Use

Say our document example.md contains:

1# GFM
2
3## Autolink literals
4
5www.example.com, https://example.com, and contact@example.com.
6
7## Footnote
8
9A note[^1]
10
11[^1]: Big note.
12
13## Strikethrough
14
15~one~ or ~~two~~ tildes.
16
17## Table
18
19| a | b  |  c |  d  |
20| - | :- | -: | :-: |
21
22## Tasklist
23
24* [ ] to do
25* [x] done

…and our module example.js looks as follows:

1import fs from 'node:fs/promises'
2import {fromMarkdown} from 'mdast-util-from-markdown'
3import {gfmFromMarkdown, gfmToMarkdown} from 'mdast-util-gfm'
4import {toMarkdown} from 'mdast-util-to-markdown'
5import {gfm} from 'micromark-extension-gfm'
6
7const value = await fs.readFile('example.md', 'utf8')
8
9const tree = fromMarkdown(value, {
10  extensions: [gfm()],
11  mdastExtensions: [gfmFromMarkdown()]
12})
13
14console.log(tree)
15
16const result = toMarkdown(tree, {extensions: [gfmToMarkdown()]})
17
18console.log(result)

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

1{
2  type: 'root',
3  children: [
4    {type: 'heading', depth: 1, children: [{type: 'text', value: 'GFM'}]},
5    {
6      type: 'heading',
7      depth: 2,
8      children: [{type: 'text', value: 'Autolink literals'}]
9    },
10    {
11      type: 'paragraph',
12      children: [
13        {
14          type: 'link',
15          title: null,
16          url: 'http://www.example.com',
17          children: [{type: 'text', value: 'www.example.com'}]
18        },
19        {type: 'text', value: ', '},
20        {
21          type: 'link',
22          title: null,
23          url: 'https://example.com',
24          children: [{type: 'text', value: 'https://example.com'}]
25        },
26        {type: 'text', value: ', and '},
27        {
28          type: 'link',
29          title: null,
30          url: 'mailto:contact@example.com',
31          children: [{type: 'text', value: 'contact@example.com'}]
32        },
33        {type: 'text', value: '.'}
34      ]
35    },
36    {type: 'heading', depth: 2, children: [{type: 'text', value: 'Footnote'}]},
37    {
38      type: 'paragraph',
39      children: [
40        {type: 'text', value: 'A note'},
41        {type: 'footnoteReference', identifier: '1', label: '1'}
42      ]
43    },
44    {
45      type: 'footnoteDefinition',
46      identifier: '1',
47      label: '1',
48      children: [
49        {type: 'paragraph', children: [{type: 'text', value: 'Big note.'}]}
50      ]
51    },
52    {
53      type: 'heading',
54      depth: 2,
55      children: [{type: 'text', value: 'Strikethrough'}]
56    },
57    {
58      type: 'paragraph',
59      children: [
60        {
61          type: 'delete',
62          children: [{type: 'text', value: 'one'}]
63        },
64        {type: 'text', value: ' or '},
65        {
66          type: 'delete',
67          children: [{type: 'text', value: 'two'}]
68        },
69        {type: 'text', value: ' tildes.'}
70      ]
71    },
72    {type: 'heading', depth: 2, children: [{type: 'text', value: 'Table'}]},
73    {
74      type: 'table',
75      align: [null, 'left', 'right', 'center'],
76      children: [
77        {
78          type: 'tableRow',
79          children: [
80            {type: 'tableCell', children: [{type: 'text', value: 'a'}]},
81            {type: 'tableCell', children: [{type: 'text', value: 'b'}]},
82            {type: 'tableCell', children: [{type: 'text', value: 'c'}]},
83            {type: 'tableCell', children: [{type: 'text', value: 'd'}]}
84          ]
85        }
86      ]
87    },
88    {type: 'heading', depth: 2, children: [{type: 'text', value: 'Tasklist'}]},
89    {
90      type: 'list',
91      ordered: false,
92      start: null,
93      spread: false,
94      children: [
95        {
96          type: 'listItem',
97          spread: false,
98          checked: false,
99          children: [
100            {type: 'paragraph', children: [{type: 'text', value: 'to do'}]}
101          ]
102        },
103        {
104          type: 'listItem',
105          spread: false,
106          checked: true,
107          children: [
108            {type: 'paragraph', children: [{type: 'text', value: 'done'}]}
109          ]
110        }
111      ]
112    }
113  ]
114}

1# GFM
2
3## Autolink literals
4
5[www.example.com](http://www.example.com), <https://example.com>, and <contact@example.com>.
6
7## Footnote
8
9A note[^1]
10
11[^1]: Big note.
12
13## Strikethrough
14
15~~one~~ or ~~two~~ tildes.
16
17## Table
18
19| a | b  |  c |  d  |
20| - | :- | -: | :-: |
21
22## Tasklist
23
24*   [ ] to do
25*   [x] done

API

This package exports the identifiers gfmFromMarkdown and gfmToMarkdown. There is no default export.

gfmFromMarkdown()

Create an extension for mdast-util-from-markdown to enable GFM (autolink literals, footnotes, strikethrough, tables, tasklists).

Returns

Extension for mdast-util-from-markdown to enable GFM (Array<FromMarkdownExtension>).

gfmToMarkdown(options?)

Create an extension for mdast-util-to-markdown to enable GFM (autolink literals, footnotes, strikethrough, tables, tasklists).

Parameters

• options (Options) — configuration

Returns

Extension for mdast-util-to-markdown to enable GFM (Array<ToMarkdownExtension>).

Options

Configuration (TypeScript type).

Fields

• firstLineBlank (boolean, default: false) — use a blank line for the first line of footnote definitions
• stringLength (((value: string) => number), default: s => s.length) — function to detect the length of table cell content, used when aligning the delimiters between cells
• tableCellPadding (boolean, default: true) — whether to add a space of padding between delimiters and cells
• tablePipeAlign (boolean, default: true) — whether to align the delimiters

HTML

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

Syntax

See Syntax in micromark-extension-gfm.

Syntax tree

This utility combines several mdast utilities. See their readmes for the node types supported in the tree:

• mdast-util-gfm-autolink-literal — GFM autolink literals
• mdast-util-gfm-footnote — GFM footnotes
• mdast-util-gfm-strikethrough — GFM strikethrough
• mdast-util-gfm-table — GFM tables
• mdast-util-gfm-task-list-item — GFM tasklists

Types

This package is fully typed with TypeScript. It exports the additional type Options.

The Delete, FootnoteDefinition, FootnoteReference, Table, TableRow, and TableCell types of the mdast nodes are exposed from @types/mdast.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, mdast-util-gfm@^3, compatible with Node.js 16.

Related

• remark-gfm — remark plugin to support GFM
• micromark-extension-gfm — micromark extension to parse GFM

Contribute

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.

License

MIT © Titus Wormer