mdast-util-gfm-strikethrough

What is mdast-util-gfm-strikethrough?

The `mdast-util-gfm-strikethrough` package is a utility for working with strikethrough text in Markdown Abstract Syntax Trees (MDAST). It provides functionality to parse and serialize strikethrough text according to the GitHub Flavored Markdown (GFM) specification.

What are mdast-util-gfm-strikethrough's main functionalities?

Parse Strikethrough

This feature allows you to parse Markdown text containing strikethrough syntax into an MDAST. The code sample demonstrates how to convert a Markdown string with strikethrough text into an MDAST tree.

const { fromMarkdown } = require('mdast-util-from-markdown');
const { gfmStrikethrough } = require('mdast-util-gfm-strikethrough');

const markdown = 'This is ~~strikethrough~~ text.';
const tree = fromMarkdown(markdown, { extensions: [gfmStrikethrough()] });
console.log(JSON.stringify(tree, null, 2));

Serialize Strikethrough

This feature allows you to serialize an MDAST containing strikethrough nodes back into Markdown text. The code sample demonstrates how to convert an MDAST tree with strikethrough nodes into a Markdown string.

const { toMarkdown } = require('mdast-util-to-markdown');
const { gfmStrikethrough } = require('mdast-util-gfm-strikethrough');

const tree = {
  type: 'root',
  children: [
    {
      type: 'paragraph',
      children: [
        { type: 'text', value: 'This is ' },
        { type: 'delete', children: [{ type: 'text', value: 'strikethrough' }] },
        { type: 'text', value: ' text.' }
      ]
    }
  ]
};

const markdown = toMarkdown(tree, { extensions: [gfmStrikethrough()] });
console.log(markdown);

Other packages similar to mdast-util-gfm-strikethrough

remark-gfm

The `remark-gfm` package is a plugin for the `remark` ecosystem that adds support for GitHub Flavored Markdown (GFM) syntax, including strikethrough. It provides a more comprehensive set of GFM features compared to `mdast-util-gfm-strikethrough`, which focuses specifically on strikethrough.

markdown-it

The `markdown-it` package is a Markdown parser that supports a wide range of Markdown features, including GFM strikethrough. It is a more general-purpose parser compared to `mdast-util-gfm-strikethrough`, which is specifically designed for working with MDAST.

turndown

The `turndown` package is a HTML to Markdown converter that supports various Markdown features, including GFM strikethrough. It is useful for converting HTML content to Markdown, whereas `mdast-util-gfm-strikethrough` is focused on parsing and serializing strikethrough in MDAST.

README

mdast-util-gfm-strikethrough

Extension for mdast-util-from-markdown and/or mdast-util-to-markdown to support GitHub flavored markdown strikethrough (like this) in mdast. When parsing (from-markdown), must be combined with micromark-extension-gfm-strikethrough.

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

Install

npm:

npm install mdast-util-gfm-strikethrough

Use

Say our script, example.js, looks as follows:

var fromMarkdown = require('mdast-util-from-markdown')
var toMarkdown = require('mdast-util-to-markdown')
var syntax = require('micromark-extension-gfm-strikethrough')
var strikethrough = require('mdast-util-gfm-strikethrough')

var doc = '*Emphasis*, **importance**, and ~~strikethrough~~.'

var tree = fromMarkdown(doc, {
  extensions: [syntax()],
  mdastExtensions: [strikethrough.fromMarkdown]
})

console.log(tree)

var out = toMarkdown(tree, {extensions: [strikethrough.toMarkdown]})

console.log(out)

Now, running node example yields:

{
  type: 'root',
  children: [
    {
      type: 'paragraph',
      children: [
        {type: 'emphasis', children: [{type: 'text', value: 'Emphasis'}]},
        {type: 'text', value: ', '},
        {type: 'strong', children: [{type: 'text', value: 'importance'}]},
        {type: 'text', value: ', and '},
        {type: 'delete', children: [{type: 'text', value: 'strikethrough'}]},
        {type: 'text', value: '.'}
      ]
    }
  ]
}

*Emphasis*, **importance**, and ~~strikethrough~~.

API

strikethrough.fromMarkdown

strikethrough.toMarkdown

Note: the separate extensions are also available at mdast-util-gfm-strikethrough/from-markdown and mdast-util-gfm-strikethrough/to-markdown.

Support strikethrough. The exports are extensions, respectively for mdast-util-from-markdown and mdast-util-to-markdown.

Related

• remarkjs/remark — markdown processor powered by plugins
• remarkjs/remark-gfm — remark plugin to support GFM
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-gfm-strikethrough — micromark extension to parse GFM 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 syntax-tree/.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