micromark-extension-gfm-strikethrough
micromark extension to support GitHub flavored markdown (GFM)
strikethrough (like this).
This syntax extension matches either the GFM spec (only two tildes work) or
github.com (both one or two tildes, when they match, work).
When to use this
You should probably use micromark-extension-gfm
instead, which combines this package with other GFM features.
Alternatively, if you don’t want all of GFM, use this package.
Install
This package is ESM only:
Node 12+ is needed to use it and it must be import
ed instead of require
d.
npm:
npm install micromark-extension-gfm-strikethrough
Use
import {micromark} from 'micromark'
import {
gfmStrikethrough,
gfmStrikethroughHtml
} from 'micromark-extension-gfm-strikethrough'
const output = micromark('Some ~strikethrough~.', {
extensions: [gfmStrikethrough()],
htmlExtensions: [gfmStrikethroughHtml]
})
console.log(output)
Yields:
<p>Some <del>strikethrough</del></p>.
API
This package exports the following identifiers: gfmStrikethrough
,
gfmStrikethroughHtml
.
There is no default export.
The export map supports the endorsed
development
condition.
Run node --conditions development module.js
to get instrumented dev code.
Without this condition, production code is loaded.
gfmStrikethrough(options?)
gfmStrikethroughHtml
Support strikethrough (like this).
gfmStrikethrough
is a function that can be called with options and returns
an extension for micromark to parse strikethrough (can be passed in
extensions
).
gfmStrikethroughHtml
is an extension for micromark to compile as <del>
elements (can be passed in htmlExtensions
).
options
options.singleTilde
Whether to support strikethrough with a single tilde (boolean
, default:
true
).
Single tildes work on github.com, but are technically prohibited by the GFM
spec.
Related
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