micromark-extension-gfm-strikethrough
Advanced tools
Package description
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.
Readme
micromark extension to support GitHub flavored markdown (GFM) strikethrough.
This package is a micromark extension to add support for GFM strikethrough.
Strikethrough on github.com, which this extension matches, can use one
(~one~) or two (~~two~~) tildes.
You can also strictly match the GFM spec instead of their implementation by
passing singleTilde: false.
In many cases, when working with micromark, you’d want to use
micromark-extension-gfm instead, which combines
this package with other GFM features.
When working with syntax trees, you’d want to combine this package with
mdast-util-gfm-strikethrough (or
mdast-util-gfm when using micromark-extension-gfm).
These tools are all rather low-level.
In most cases, you’d instead want to use remark-gfm with
remark.
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install micromark-extension-gfm-strikethrough
In Deno with Skypack:
import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-strikethrough@1?dts'
In browsers with Skypack:
<script type="module">
import {gfmStrikethrough, gfmStrikethroughHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-strikethrough@1?min'
</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 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?)A function that can be called to get an extension for micromark to parse
GFM strikethrough (can be passed in extensions).
optionsConfiguration (optional).
options.singleTildeWhether to support strikethrough with a single tilde (boolean, default:
true).
Single tildes work on github.com, but are technically prohibited by GFM.
gfmStrikethroughHtmlAn extension to compile them to HTML (can be passed in htmlExtensions).
This package is fully typed with TypeScript.
It exports additional Options type that models its respective interface.
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.
This package is safe.
syntax-tree/mdast-util-gfm-strikethrough
— support GFM strikethrough in mdastsyntax-tree/mdast-util-gfm
— support GFM in mdastremarkjs/remark-gfm
— support 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
The npm package micromark-extension-gfm-strikethrough receives a total of 2,555,279 weekly downloads. As such, micromark-extension-gfm-strikethrough popularity was classified as popular.
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 1 open source maintainer 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
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.