micromark-extension-gfm-strikethrough
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatmicromark extensions to support GFM strikethrough.
Contents
* [`gfmStrikethrough(options?)`](#gfmstrikethroughoptions)
* [`gfmStrikethroughHtml()`](#gfmstrikethroughhtml)
* [`Options`](#options)
What is this?
This package contains extensions that add support for strikethrough as enabled by GFM tomicromark
micromark.When to use this
This project is useful when you want to support strikethrough in markdown.You can use these extensions when you are working with
micromark
micromark.
To support all GFM features, use
micromark-extension-gfm
micromark-extension-gfm.When you need a syntax tree, you can combine this package with
mdast-util-gfm-strikethrough
mdast-util-gfm-strikethrough.All these packages are used
remark-gfm
remark-gfm, which focusses on making
it easier to transform content by abstracting these internals away.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install micromark-extension-gfm-strikethrough
In Deno with
esm.sh
esmsh:import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://esm.sh/micromark-extension-gfm-strikethrough@2'
In browsers with
esm.sh
esmsh:<script type="module">
import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://esm.sh/micromark-extension-gfm-strikethrough@2?bundle'
</script>
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 identifiersgfmStrikethrough
api-gfm-strikethrough and
gfmStrikethroughHtml
api-gfm-strikethrough-html.
There is no default export.The export map supports the
development
conditiondevelopment.
Run node --conditions development module.js
to get instrumented dev code.
Without this condition, production code is loaded.gfmStrikethrough(options?)
Create an extension for micromark
to enable GFM strikethrough syntax.Parameters
options
(Options
api-options, optional)
— configuration
Returns
Extension formicromark
that can be passed in extensions
, to
enable GFM strikethrough syntax (Extension
micromark-extension).gfmStrikethroughHtml()
Create an HTML extension for micromark
to support GFM strikethrough when
serializing to HTML.Returns
Extension formicromark
that can be passed in htmlExtensions
, to support
GFM strikethrough when serializing to HTML
(HtmlExtension
micromark-html-extension).Options
Configuration (TypeScript type).Fields
singleTilde
(boolean
, default:true
)
— whether to support strikethrough with a single tilde.
Single tildes work on github.com, but are technically prohibited by the GFM
spec
Authoring
When authoring markdown with strikethrough, it is recommended to use two markers. Whilegithub.com
allows single tildes too, it technically prohibits it in
their spec.HTML
When tilde sequences match, they together relate to the<del>
element in
HTML.
See § 4.7.2 The del
elementhtml-del in the HTML spec for more info.CSS
GitHub itself does not apply interesting CSS todel
elements.
It currently (July 2022) does change code
in del
.del code {
text-decoration: inherit;
}
For the complete actual CSS see
sindresorhus/github-markdown-css
github-markdown-css.Syntax
Strikethrough sequences form with the following BNF:gfm_attention_sequence ::= 1*'~'
Sequences are matched together to form strikethrough based on which character they contain, how long they are, and what character occurs before and after each sequence. Otherwise they are turned into data.
Types
This package is fully typed with TypeScript. It exports the additional typeOptions
api-options.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,
micromark-extension-gfm-strikethrough@^2
, compatible with Node.js 16.This package works with
micromark
version 3
and later.Security
This package is safe.Related
— support all of GFM
— support all of GFM in mdast
— support all of GFM in mdast
— support all of GFM in remark
Contribute
Seecontributing.md
in micromark/.github
contributing for ways to get
started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.