micromark extension to support GFM (GitHub Flavored Markdown)
npm install micromark-extension-gfm[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[micromark][] extensions to support [GitHub flavored markdown][gfm] (GFM).
* What is this?
* When to use this
* Install
* Use
* API
* gfm(options?)
* gfmHtml(options?)
* Options
* HtmlOptions
* Bugs
* Authoring
* HTML
* CSS
* Syntax
* Types
* Compatibility
* Security
* Contribute
* License
This package contains extensions that add support for all features enabled by
GFM to [micromark][micromark].
It supports autolink literals, footnotes, strikethrough, tables, tagfilter, and
tasklists.
This project is useful when you want to support GFM in markdown.
You can use these extensions when you are working with [micromark][micromark].
Alternatively, you can also use the underlying features separately:
* [micromark-extension-gfm-autolink-literal][gfm-autolink-literal]
— support GFM [autolink literals][]
* [micromark-extension-gfm-footnote][gfm-footnote]
— support GFM [footnotes][]
* [micromark-extension-gfm-strikethrough][gfm-strikethrough]
— support GFM [strikethrough][]
* [micromark-extension-gfm-table][gfm-table]
— support GFM [tables][]
* [micromark-extension-gfm-tagfilter][gfm-tagfilter]
— support GFM [tagfilter][]
* [micromark-extension-gfm-task-list-item][gfm-task-list-item]
— support GFM [tasklists][]
When you need a syntax tree, combine this package with
[mdast-util-gfm][mdast-util-gfm].
All these packages are used in [remark-gfm][remark-gfm], which focusses on
making it easier to transform content by abstracting these internals away.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install micromark-extension-gfm
In Deno with [esm.sh][esmsh]:
`js`
import {gfm, gfmHtml} from 'https://esm.sh/micromark-extension-gfm@3'
In browsers with [esm.sh][esmsh]:
`html`
Say our document example.md contains:
`markdownGFM
www.example.com, https://example.com, and contact@example.com.
A note[^1]
[^1]: Big note.
~one~ or ~~two~~ tildes.
| a | b | c | d |
| - | :- | -: | :-: |
* [ ] to do
* [x] done
`
…and our module example.js looks as follows:
`js
import fs from 'node:fs/promises'
import {micromark} from 'micromark'
import {gfm, gfmHtml} from 'micromark-extension-gfm'
const output = micromark(await fs.readFile('example.md'), {
allowDangerousHtml: true,
extensions: [gfm()],
htmlExtensions: [gfmHtml()]
})
console.log(output)
`
…now running node example.js yields:
` www.example.com, https://example.com, and contact@example.com. A note1 Big note. ↩html`GFM
Autolink literals
Footnote
Strikethrough
one or two tildes.Table
a b c d Tag filter
<plaintext>Tasklist
Footnotes
This package exports the identifiers [gfm][api-gfm] andgfmHtml
[][api-gfm-html].
There is no default export.
The separate extensions support the [development condition][development].node --conditions development module.js
Run to get instrumented dev code.
Without this condition, production code is loaded.
Create an extension for micromark to enable GFM syntax.
###### Parameters
* options ([Options][api-options], optional)micromark-extens-gfm-strikethrough
— configuration; passed to
[][gfm-strikethrough-options]
###### Returns
Extension for micromark that can be passed in extensions to enable GFMExtension
syntax ([][micromark-extension]).
Create an extension for micromark to support GFM when serializing to HTML.
###### Parameters
* options ([HtmlOptions][api-html-options], optional)micromark-extens-gfm-footnote
— configuration; passed to
[][gfm-footnote-html-options]
###### Returns
Extension for micromark that can be passed in htmlExtensions to support GFMHtmlExtension
when serializing to HTML ([][micromark-html-extension]).
Configuration for syntax (TypeScript type).
###### Type
`ts`
export type {Options} from 'micromark-extension-gfm-strikethrough'
[See Options][gfm-strikethrough-options].
Configuration for HTML (TypeScript type).
###### Type
`ts`
export type {HtmlOptions} from 'micromark-extension-gfm-footnote'
[See HtmlOptions][gfm-footnote-html-options].
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
* tagfilter: n/a
* tasklists: n/a
For recommendations on how to author GFM, see each corresponding readme:
* autolink literal
* footnote
* strikethrough
* table
* tagfilter: n/a
* tasklists
For info on what HTML features GFM relates to, see each corresponding readme:
* autolink literal
* footnote
* strikethrough
* table
* tagfilter
* tasklists
For info on how GitHub styles these features, see each corresponding readme:
* autolink literal
* footnote
* strikethrough
* table
* tagfilter: n/a
* tasklists
For info on the syntax of these features, see each corresponding readme:
* autolink literal
* footnote
* strikethrough
* table
* tagfilter: n/a
* tasklists
This package is fully typed with [TypeScript][].
It exports the additional types [HtmlOptions][api-html-options] andOptions
[][api-options].
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,
micromark-extension-gfm@^3, compatible with Node.js 16.
This package works with micromark version 3 and later.
This package is safe.
Setting clobberPrefix = '' is dangerous, it opens you up to DOM clobbering.labelTagName
The and labelAttributes options are unsafe when used with user
content, they allow defining arbitrary HTML.
See [contributing.md in micromark/.github][contributing] for ways to getsupport.md`][support] for ways to get help.
started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/micromark/micromark-extension-gfm/workflows/main/badge.svg
[build]: https://github.com/micromark/micromark-extension-gfm/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark-extension-gfm.svg
[coverage]: https://codecov.io/github/micromark/micromark-extension-gfm
[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-gfm.svg
[downloads]: https://www.npmjs.com/package/micromark-extension-gfm
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-extension-gfm
[size]: https://bundlejs.com/?q=micromark-extension-gfm
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/micromark/micromark/discussions
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[contributing]: https://github.com/micromark/.github/blob/main/contributing.md
[support]: https://github.com/micromark/.github/blob/main/support.md
[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
[typescript]: https://www.typescriptlang.org
[gfm]: https://github.github.com/gfm/
[strikethrough]: https://github.github.com/gfm/#strikethrough-extension-
[tables]: https://github.github.com/gfm/#tables-extension-
[tasklists]: https://github.github.com/gfm/#task-list-items-extension-
[autolink literals]: https://github.github.com/gfm/#autolinks-extension-
[tagfilter]: https://github.github.com/gfm/#disallowed-raw-html-extension-
[footnotes]: https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/
[micromark]: https://github.com/micromark/micromark
[micromark-extension]: https://github.com/micromark/micromark#syntaxextension
[micromark-html-extension]: https://github.com/micromark/micromark#htmlextension
[gfm-strikethrough]: https://github.com/micromark/micromark-extension-gfm-strikethrough
[gfm-strikethrough-options]: https://github.com/micromark/micromark-extension-gfm-strikethrough#options
[gfm-autolink-literal]: https://github.com/micromark/micromark-extension-gfm-autolink-literal
[gfm-footnote]: https://github.com/micromark/micromark-extension-gfm-footnote
[gfm-footnote-html-options]: https://github.com/micromark/micromark-extension-gfm-footnote#htmloptions
[gfm-table]: https://github.com/micromark/micromark-extension-gfm-table
[gfm-tagfilter]: https://github.com/micromark/micromark-extension-gfm-tagfilter
[gfm-task-list-item]: https://github.com/micromark/micromark-extension-gfm-task-list-item
[remark-gfm]: https://github.com/remarkjs/remark-gfm
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
[api-gfm]: #gfmoptions
[api-gfm-html]: #gfmhtmloptions
[api-options]: #options
[api-html-options]: #htmloptions