micromark-extension-gfm-strikethrough

micromark extension to support GitHub flavored markdown (GFM) strikethrough.

Contents

• What is this?
• When to use this
• Install
• Use
• API
  • gfmStrikethrough(options?)
  • gfmStrikethroughHtml
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

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.

When to use this

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.

Install

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>

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?)

A function that can be called to get an extension for micromark to parse GFM strikethrough (can be passed in extensions).

options

Configuration (optional).

options.singleTilde

Whether to support strikethrough with a single tilde (boolean, default: true). Single tildes work on github.com, but are technically prohibited by GFM.

gfmStrikethroughHtml

An extension to compile them to HTML (can be passed in htmlExtensions).

Types

This package is fully typed with TypeScript. It exports additional Options type that models its respective interface.

Compatibility

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.

Security

This package is safe.

Related

• syntax-tree/mdast-util-gfm-strikethrough — support GFM strikethrough in mdast
• syntax-tree/mdast-util-gfm — support GFM in mdast
• remarkjs/remark-gfm — support GFM in remark

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