micromark-extension-gfm-strikethrough
Advanced tools
micromark extension to support GFM strikethrough
The micromark-extension-gfm-strikethrough package is an extension for the micromark Markdown parser that adds support for GitHub Flavored Markdown (GFM) strikethrough syntax. This allows users to parse and render strikethrough text in Markdown documents according to the GFM specification.
Strikethrough Syntax Parsing
This feature allows the parsing of strikethrough syntax (~~strikethrough~~) in Markdown and converts it to the appropriate HTML <del> tag.
import { micromark } from 'micromark';
import { gfmStrikethrough } from 'micromark-extension-gfm-strikethrough';
const markdown = 'This is ~~strikethrough~~ text.';
const html = micromark(markdown, {
extensions: [gfmStrikethrough()]
});
console.log(html); // Outputs: 'This is <del>strikethrough</del> text.'markdown-it is a Markdown parser with a plugin system. It has a plugin called markdown-it-mark that can handle strikethrough syntax similar to micromark-extension-gfm-strikethrough. However, markdown-it is a full parser, whereas micromark-extension-gfm-strikethrough is an extension for the micromark parser.
remark-gfm is a plugin for the remark Markdown processor that adds support for GFM features, including strikethrough. It is similar to micromark-extension-gfm-strikethrough but is designed to work with the remark ecosystem.
showdown is another Markdown to HTML converter that can be extended with plugins. It has built-in support for GFM strikethrough without the need for additional plugins, offering similar functionality to micromark-extension-gfm-strikethrough.
micromark extensions to support GFM strikethrough.
This package contains extensions that add support for strikethrough as enabled
by GFM to micromark.
This project is useful when you want to support strikethrough in markdown.
You can use these extensions when you are working with micromark.
To support all GFM features, use
micromark-extension-gfm.
When you need a syntax tree, you can combine this package with
mdast-util-gfm-strikethrough.
All these packages are used remark-gfm, which focusses on making
it easier to transform content by abstracting these internals away.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install micromark-extension-gfm-strikethrough
In Deno with esm.sh:
import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://esm.sh/micromark-extension-gfm-strikethrough@2'
In browsers with esm.sh:
<script type="module">
import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://esm.sh/micromark-extension-gfm-strikethrough@2?bundle'
</script>
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>.
This package exports the identifiers
gfmStrikethrough and
gfmStrikethroughHtml.
There is no default export.
The export map supports the development condition.
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.
options (Options, optional)
— configurationExtension for micromark that can be passed in extensions, to
enable GFM strikethrough syntax (Extension).
gfmStrikethroughHtml()Create an HTML extension for micromark to support GFM strikethrough when
serializing to HTML.
Extension for micromark that can be passed in htmlExtensions, to support
GFM strikethrough when serializing to HTML
(HtmlExtension).
OptionsConfiguration (TypeScript type).
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
specWhen 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 <del> element in
HTML.
See § 4.7.2 The del element in the HTML spec for more info.
GitHub itself does not apply interesting CSS to del 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.
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.
This package is fully typed with TypeScript.
It exports the additional type 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
— support all of GFMmdast-util-gfm-strikethrough
— support all of GFM in mdastmdast-util-gfm
— support all of GFM in mdastremark-gfm
— support all of GFM in remarkSee 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.
FAQs
micromark extension to support GFM strikethrough
We found that micromark-extension-gfm-strikethrough demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.