Gathering detailed insights and metrics for remark-gfm
Gathering detailed insights and metrics for remark-gfm
Gathering detailed insights and metrics for remark-gfm
Gathering detailed insights and metrics for remark-gfm
remark-footnotes
Deprecated: this package is no longer maintained. Please use [`remark-gfm`][gfm] instead. That package match how footnotes work on github.com, which is more likely to match the expectations of authors.
micromark
small commonmark compliant markdown parser with positional info and concrete tokens
react-markdown
React component to render markdown
mdast-util-footnote
Deprecated: use [`remark-gfm`][remark-gfm] instead. GFM now includes footnotes.
remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
npm install remark-gfm
Typescript
Module System
Node Version
NPM Version
JavaScript (100%)
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
MIT License
960 Stars
67 Commits
33 Forks
11 Watchers
1 Branches
14 Contributors
Updated on Jul 12, 2025
Latest Version
4.0.1
Package Id
remark-gfm@4.0.1
Unpacked Size
21.48 kB
Size
7.44 kB
File Count
8
NPM Version
11.1.0
Node Version
23.1.0
Published on
Feb 10, 2025
Cumulative downloads
Total Downloads
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
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 id
s 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).
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
.
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install remark-gfm
In Deno with esm.sh
:
1import remarkGfm from 'https://esm.sh/remark-gfm@4'
In browsers with esm.sh
:
1<script type="module"> 2 import remarkGfm from 'https://esm.sh/remark-gfm@4?bundle' 3</script>
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
contains:
1import rehypeStringify from 'rehype-stringify' 2import remarkGfm from 'remark-gfm' 3import remarkParse from 'remark-parse' 4import remarkRehype from 'remark-rehype' 5import {read} from 'to-vfile' 6import {unified} from 'unified' 7 8const file = await unified() 9 .use(remarkParse) 10 .use(remarkGfm) 11 .use(remarkRehype) 12 .use(rehypeStringify) 13 .process(await read('example.md')) 14 15console.log(String(file))
…then running node example.js
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>Tasklist</h2> 20<ul class="contains-task-list"> 21<li class="task-list-item"><input type="checkbox" disabled> to do</li> 22<li class="task-list-item"><input type="checkbox" checked disabled> done</li> 23</ul> 24<section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2> 25<ol> 26<li id="user-content-fn-1"> 27<p>Big note. <a href="#user-content-fnref-1" data-footnote-backref class="data-footnote-backref" aria-label="Back to content">↩</a></p> 28</li> 29</ol> 30</section>
This package exports no identifiers.
The default export is remarkGfm
.
unified().use(remarkGfm[, options])
Add support GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
options
(Options
, optional)
— configurationNothing (undefined
).
Options
Configuration (TypeScript type).
firstLineBlank
(boolean
, default: false
)
— serialize with a blank line for the first line of footnote definitionsstringLength
(((value: string) => number)
, default: d => d.length
)
— detect the size of table cells, used when aligning cellssingleTilde
(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 strikethroughtablePipeAlign
(boolean
, default: true
)
— whether to align table pipestableCellPadding
(boolean
, default: true
)
— whether to add a space of padding between table pipes and cellssingleTilde
To turn off support for parsing strikethrough with single tildes, pass
singleTilde: false
:
1// … 2 3const file = await unified() 4 .use(remarkParse) 5 .use(remarkGfm, {singleTilde: false}) 6 .use(remarkRehype) 7 .use(rehypeStringify) 8 .process('~one~ and ~~two~~') 9 10console.log(String(file))
Yields:
1<p>~one~ and <del>two</del></p>
stringLength
It’s possible to align tables based on the visual width of cells. First, let’s show the problem:
1import {remark} from 'remark' 2import remarkGfm from 'remark-gfm' 3 4const input = `| Alpha | Bravo | 5| - | - | 6| 中文 | Charlie | 7| 👩❤️👩 | Delta |` 8 9const file = await remark().use(remarkGfm).process(input) 10 11console.log(String(file))
The above code shows how remark can be used to format markdown. The output is as follows:
1| Alpha | Bravo | 2| -------- | ------- | 3| 中文 | Charlie | 4| 👩❤️👩 | Delta |
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@@ -1,5 +1,6 @@ 2 import {remark} from 'remark' 3 import remarkGfm from 'remark-gfm' 4+import stringWidth from 'string-width' 5 6@@ -10,7 +11,7 @@ async function main() { 7 | 👩❤️👩 | Delta |` 8 9-const file = await remark().use(remarkGfm).process(input) 10+const file = await remark() 11+ .use(remarkGfm, {stringLength: stringWidth}) 12+ .process(input) 13 14 console.log(String(file))
The output of our code with these changes is as follows:
1| Alpha | Bravo | 2| ----- | ------- | 3| 中文 | Charlie | 4| 👩❤️👩 | Delta |
For bugs present in GFM but not here, or other peculiarities that are supported, see each corresponding readme:
For recommendations on how to author GFM, see each corresponding readme:
This plugin does not handle how markdown is turned to HTML.
See remark-rehype
for how that happens and how to change it.
For info on how GitHub styles these features, see each corresponding readme:
For info on the syntax of these features, see each corresponding readme:
For info on the syntax tree of these features, see each corresponding readme:
This package is fully typed with TypeScript.
It exports the additional type Options
.
The node types are supported in @types/mdast
by default.
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.
Use of remark-gfm
does not involve rehype (hast) or user
content so there are no openings for cross-site scripting (XSS)
attacks.
remark-github
— link references to commits, issues, PRs, and usersremark-breaks
— support breaks without needing spaces or escapes (enters to <br>
)remark-frontmatter
— support frontmatter (YAML, TOML, and more)remark-directive
— support directivesremark-math
— support mathremark-mdx
— support MDX (ESM, JSX, expressions)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.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
Reason
security policy file detected
Details
Reason
0 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 1
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More