micromark-extension-gfm-strikethrough

micromark extension to support GitHub flavored markdown strikethrough (~~like this~~). This syntax extension matches either the GFM spec (only two tildes work) or github.com (both one or two tildes, when they match, work).

This package provides the low-level modules for integrating with the micromark tokenizer and the micromark HTML compiler.

You probably shouldn’t use this package directly, but instead use mdast-util-gfm-strikethrough with mdast.

Install

npm:

npm install micromark-extension-gfm-strikethrough

API

html

syntax(options?)

Note: syntax is the default export of this module, html is available at micromark-extension-gfm-strikethrough/html.

Support strikethrough (~~like this~~). The export of syntax is a function that can be called with options and returns an extension for the micromark parser (to tokenize strikethrough; can be passed in extensions). The export of html is an extension for the default HTML compiler (to compile as <del> elements; can be passed in htmlExtensions).

options

options.singleTilde

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

Related

• remarkjs/remark — markdown processor powered by plugins
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• syntax-tree/mdast-util-gfm-strikethrough — mdast utility to support strikethrough
• syntax-tree/mdast-util-from-markdown — mdast parser using micromark to create mdast from markdown
• syntax-tree/mdast-util-to-markdown — mdast serializer to create markdown from mdast

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