This package is a unified (remark) plugin to enable the extensions to
markdown that GitHub adds with GFM: autolink literals (www.x.com), footnotes
([^1]), strikethrough (~~stuff~~), tables (| cell |…), and tasklists
(* [x]).
You can use this plugin to add support for parsing and serializing them.
These extensions by GitHub to CommonMark are called GFM (GitHub Flavored
Markdown).
This plugin does not handle how markdown is turned to HTML.
That’s done by remark-rehype.
If your content is not in English and uses footnotes, you should configure that
plugin.
When generating HTML, you might also want to enable rehype-slug
to add ids on headings.
A different plugin, remark-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.
Another plugin, remark-github, adds support for how markdown
works in relation to a certain GitHub repo in comments, issues, PRs, and
releases, by linking references to commits, issues, and users.
Yet another plugin, remark-breaks, turns soft line endings
(enters) into hard breaks (<br>s).
GitHub does this in a few places (comments, issues, PRs, and releases).
When should I 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 remark-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.
<script type="module"> import remarkGfm from 'https://esm.sh/remark-gfm@4?bundle'</script>
Use
Say our document example.md contains:
# GFM## Autolink literalswww.example.com, https://example.com, and contact@example.com.## FootnoteA note[^1][^1]: Big note.## Strikethrough~one~ or ~~two~~ tildes.## Table| a | b | c | d || - | :- | -: | :-: |## Tasklist* [ ] to do* [x] done
…and our module example.js contains:
import rehypeStringify from 'rehype-stringify'import remarkGfm from 'remark-gfm'import remarkParse from 'remark-parse'import remarkRehype from 'remark-rehype'import {read} from 'to-vfile'import {unified} from 'unified'const file = await unified() .use(remarkParse) .use(remarkGfm) .use(remarkRehype) .use(rehypeStringify) .process(await read('example.md'))console.log(String(file))
firstLineBlank (boolean, default: false)
— serialize with a blank line for the first line of footnote definitions
stringLength (((value: string) => number), default: d => d.length)
— detect the size of table cells, used when aligning cells
singleTilde (boolean, default: true)
— whether to support strikethrough with a single tilde;
single tildes work on github.com, but are technically prohibited by GFM;
you can always use 2 or more tildes for strikethrough
tablePipeAlign (boolean, default: true)
— whether to align table pipes
tableCellPadding (boolean, default: true)
— whether to add a space of padding between table pipes and cells
Examples
Example: singleTilde
To turn off support for parsing strikethrough with single tildes, pass
singleTilde: false:
To improve the alignment of these full-width characters and emoji, pass a
stringLength function that calculates the visual width of cells.
One such algorithm is string-width.
It can be used like so:
@@ -1,5 +1,6 @@ import {remark} from 'remark' import remarkGfm from 'remark-gfm'+import stringWidth from 'string-width'@@ -10,7 +11,7 @@ async function main() { | 👩❤️👩 | Delta |`-const file = await remark().use(remarkGfm).process(input)+const file = await remark()+ .use(remarkGfm, {stringLength: stringWidth})+ .process(input) console.log(String(file))
The output of our code with these changes is as follows:
This package is fully typed with TypeScript.
It exports the additional type Options.
The node types are supported in @types/mdast by default.
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, remark-gfm@^4, compatible
with Node.js 16.
This plugin works with remark-parse version 11+ (remark version 15+).
The previous version (v3) worked with remark-parse version 10 (remark
version 14).
Before that, v2 worked with remark-parse version 9 (remark version 13).
Earlier versions of remark-parse and remark had a gfm option that enabled
this functionality, which defaulted to true.