As an open-source project, remarkjs/remark-gfm has picked up 1.3k stars on GitHub (JavaScript). remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
remark plugin to support GFM (autolink literals, footnotes,
strikethrough, tables, tasklists).
Contents
What is this?
When should I use this?
Install
Use
API
unified().use(remarkGfm[, options])
Options
Examples
Example: singleTilde
Example: stringLength
Bugs
Authoring
HTML
CSS
Syntax
Syntax tree
Types
Compatibility
Security
Related
Contribute
License
What is this?
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.
If you just want to turn markdown into HTML (with maybe a few extensions such
as GFM), we recommend micromark with
micromark-extension-gfm instead.
If you don’t use plugins and want to access the syntax tree, you can use
mdast-util-from-markdown with
mdast-util-gfm.
Install
This package is ESM only.
In Node.js (version 16+), install with npm:
npm install remark-gfm
In Deno with esm.sh:
import remarkGfm from 'https://esm.sh/remark-gfm@4'
In browsers with esm.sh:
<script type="module">
import remarkGfm from 'https://esm.sh/remark-gfm@4?bundle'
</script>
Use
Say our document example.md contains:
# GFM
## Autolink literals
www.example.com, https://example.com, and [email protected].
## Footnote
A 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))
This package exports no identifiers.
The default export is remarkGfm.
unified().use(remarkGfm[, options])
Add support GFM (autolink literals, footnotes, strikethrough, tables,
tasklists).
Parameters
options (Options, optional)
— configuration
Returns
Nothing (undefined).
Options
Configuration (TypeScript type).
Fields
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:
For bugs present in GFM but not here, or other peculiarities that are
supported, see each corresponding readme:
autolink literal
footnote
strikethrough: n/a
table
tasklists: n/a
Authoring
For recommendations on how to author GFM, see each corresponding readme:
autolink literal
footnote
strikethrough
table
tasklists
HTML
This plugin does not handle how markdown is turned to HTML.
See remark-rehype for how that happens and how to change it.
CSS
For info on how GitHub styles these features, see each corresponding readme:
autolink literal
footnote
strikethrough
table
tasklists
Syntax
For info on the syntax of these features, see each corresponding readme:
autolink literal
footnote
strikethrough
table
tasklists
Syntax tree
For info on the syntax tree of these features, see each corresponding readme:
autolink literal
footnote
strikethrough
table
tasklists
Types
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.
Security
Use of remark-gfm does not involve rehype (hast) or user
content so there are no openings for cross-site scripting (XSS)
attacks.
Related
remark-github
— link references to commits, issues, PRs, and users
remark-breaks
— support breaks without needing spaces or escapes (enters to <br>)
remark-frontmatter
— support frontmatter (YAML, TOML, and more)
remark-directive
— support directives
remark-math
— support math
remark-mdx
— support MDX (ESM, JSX, expressions)
Contribute
See contributing.md in remarkjs/.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.
The most recent commit recorded on remarkjs/remark-gfm was 1.8 years ago, based on the GitHub push timestamp. The repository has 42 forks — one of the better signals of community interest.
How many stars does remarkjs/remark-gfm have?
remarkjs/remark-gfm has 1.3k GitHub stars — refresh the page for the live number, or check github.com/remarkjs/remark-gfm. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is remarkjs/remark-gfm written in?
remarkjs/remark-gfm is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
What license does remarkjs/remark-gfm use?
remarkjs/remark-gfm is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is remarkjs/remark-gfm associated with?
GitHub's repository topics for remarkjs/remark-gfm: "autolink", "gfm", "github", "remark", "remark-plugin", "strikethrough", "table", "tasklist". TopGit's editorial category is open-source.
Where can I see remarkjs/remark-gfm in action?
The project maintains a homepage at https://remark.js.org. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about remarkjs/remark-gfm?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/remarkjs/remark-gfm is the definitive source.
Read full README in the tab above.
Curious whether remark-gfm is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about remark-gfm.