micromark extension to support GFM strikethrough
npm install micromark-extension-gfm-strikethrough[![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 GFM [strikethrough][].
* What is this?
* When to use this
* Install
* Use
* API
* gfmStrikethrough(options?)
* gfmStrikethroughHtml()
* Options
* Authoring
* HTML
* CSS
* Syntax
* Types
* Compatibility
* Security
* Related
* Contribute
* License
This package contains extensions that add support for strikethrough as enabled
by GFM to [micromark][micromark].
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.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install micromark-extension-gfm-strikethrough
In Deno with [esm.sh][esmsh]:
`js`
import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://esm.sh/micromark-extension-gfm-strikethrough@2'
In browsers with [esm.sh][esmsh]:
`html`
`js
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:
` Some html`strikethrough
This package exports the identifiers
[gfmStrikethrough][api-gfm-strikethrough] andgfmStrikethroughHtml
[][api-gfm-strikethrough-html].
There is no default export.
The export map supports 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 strikethrough syntax.
###### Parameters
* options ([Options][api-options], optional)
— configuration
###### Returns
Extension for micromark that can be passed in extensions, toExtension
enable GFM strikethrough syntax ([][micromark-extension]).
Create an HTML extension for micromark to support GFM strikethrough when
serializing to HTML.
###### Returns
Extension for micromark that can be passed in htmlExtensions, to supportHtmlExtension
GFM strikethrough when serializing to HTML
([][micromark-html-extension]).
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
When authoring markdown with strikethrough, it is recommended to use two
markers.
While github.com allows single tildes too, it technically prohibits it in
their spec.
When tilde sequences match, they together relate to the element indel
HTML.
See [§ 4.7.2 The element][html-del] in the HTML spec for more info.
GitHub itself does not apply interesting CSS to del elements.code
It currently (July 2022) does change in del.
`css`
del code {
text-decoration: inherit;
}
For the complete actual CSS see
[sindresorhus/github-markdown-css][github-markdown-css].
Strikethrough sequences form with the following BNF:
`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.
This package is fully typed with [TypeScript][].
It exports the additional type [Options][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-strikethrough@^2, compatible with Node.js 16.
This package works with micromark version 3 and later.
This package is safe.
* [micromark-extension-gfm][micromark-extension-gfm]mdast-util-gfm-strikethrough
— support all of GFM
* [][mdast-util-gfm-strikethrough]mdast-util-gfm
— support all of GFM in mdast
* [][mdast-util-gfm]remark-gfm
— support all of GFM in mdast
* [][remark-gfm]
— support all of GFM in remark
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-strikethrough/workflows/main/badge.svg
[build]: https://github.com/micromark/micromark-extension-gfm-strikethrough/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark-extension-gfm-strikethrough.svg
[coverage]: https://codecov.io/github/micromark/micromark-extension-gfm-strikethrough
[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-gfm-strikethrough.svg
[downloads]: https://www.npmjs.com/package/micromark-extension-gfm-strikethrough
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-extension-gfm-strikethrough
[size]: https://bundlejs.com/?q=micromark-extension-gfm-strikethrough
[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
[typescript]: https://www.typescriptlang.org
[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
[micromark]: https://github.com/micromark/micromark
[micromark-html-extension]: https://github.com/micromark/micromark#htmlextension
[micromark-extension]: https://github.com/micromark/micromark#syntaxextension
[micromark-extension-gfm]: https://github.com/micromark/micromark-extension-gfm
[mdast-util-gfm-strikethrough]: https://github.com/syntax-tree/mdast-util-gfm-strikethrough
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
[remark-gfm]: https://github.com/remarkjs/remark-gfm
[strikethrough]: https://github.github.com/gfm/#strikethrough-extension-
[github-markdown-css]: https://github.com/sindresorhus/github-markdown-css
[html-del]: https://html.spec.whatwg.org/multipage/edits.html#the-del-element
[api-gfm-strikethrough]: #gfmstrikethroughoptions
[api-gfm-strikethrough-html]: #gfmstrikethroughhtml
[api-options]: #options