micromark-extension-gfm

micromark extension to support GitHub flavored markdown. This extension matches either the GFM spec or github.com (default).

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

When to use this

If you’re using micromark or mdast-util-from-markdown, use this package. Alternatively, if you’re using remark, use remark-gfm.

If you don’t need all of GFM, the extensions can be used separately:

• micromark/micromark-extension-gfm-autolink-literal — support GFM autolink literals
• micromark/micromark-extension-gfm-footnote — support GFM footnotes
• micromark/micromark-extension-gfm-strikethrough — support GFM strikethrough
• micromark/micromark-extension-gfm-table — support GFM tables
• micromark/micromark-extension-gfm-tagfilter — support GFM tagfilter
• micromark/micromark-extension-gfm-task-list-item — support GFM tasklists

Install

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

npm:

1npm install micromark-extension-gfm

Use

Say we have the following file, example.md:

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## Tag filter
23
24<plaintext>
25
26## Tasklist
27
28* [ ] to do
29* [x] done

And our module, example.js, looks as follows:

1import fs from 'node:fs'
2import {micromark} from 'micromark'
3import {gfm, gfmHtml} from 'micromark-extension-gfm'
4
5const output = micromark(fs.readFileSync('example.md'), {
6  allowDangerousHtml: true,
7  extensions: [gfm()],
8  htmlExtensions: [gfmHtml()]
9})
10
11console.log(output)

Now, running node example yields:

1<h1>GFM</h1>
2<h2>Autolink literals</h2>
3<p><a href="http://www.example.com">www.example.com</a>, <a href="https://example.com">https://example.com</a>, and <a href="mailto:contact@example.com">contact@example.com</a>.</p>
4<h2>Footnote</h2>
5<p>A note<sup><a href="#user-content-fn-1" id="user-content-fnref-1" data-footnote-ref="" aria-describedby="footnote-label">1</a></sup></p>
6<h2>Strikethrough</h2>
7<p><del>one</del> or <del>two</del> tildes.</p>
8<h2>Table</h2>
9<table>
10<thead>
11<tr>
12<th>a</th>
13<th align="left">b</th>
14<th align="right">c</th>
15<th align="center">d</th>
16</tr>
17</thead>
18</table>
19<h2>Tag filter</h2>
20&lt;plaintext>
21<h2>Tasklist</h2>
22<ul>
23<li><input disabled="" type="checkbox"> to do</li>
24<li><input checked="" disabled="" type="checkbox"> done</li>
25</ul>
26<section data-footnotes="" class="footnotes"><h2 id="footnote-label" class="sr-only">Footnotes</h2>
27<ol>
28<li id="user-content-fn-1">
29<p>Big note. <a href="#user-content-fnref-1" data-footnote-backref="" class="data-footnote-backref" aria-label="Back to content">↩</a></p>
30</li>
31</ol>
32</section>

API

This package exports the following identifiers: gfm, gfmHtml. There is no default export.

gfm(options?)

gfmHtml

Support GFM or markdown on github.com. gfm is a function that can be called with options and returns an extension for micromark to parse GFM (can be passed in extensions). gfmHtml is a function that can be called and returns an extension for micromark to compile as elements (can be passed in htmlExtensions).

options

options.singleTilde

Passed as singleTilde in micromark-extension-gfm-strikethrough.

Related

• remarkjs/remark — markdown processor powered by plugins
• 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
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-gfm-autolink-literal — support GFM autolink literals
• micromark/micromark-extension-gfm-footnote — support GFM footnotes
• micromark/micromark-extension-gfm-strikethrough — support GFM strikethrough
• micromark/micromark-extension-gfm-table — support GFM tables
• micromark/micromark-extension-gfm-tagfilter — support GFM tagfilter
• micromark/micromark-extension-gfm-task-list-item — support GFM tasklists

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