Now with Partition Management

    mdast-util-gfm-strikethrough
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    mdast-util-gfm-strikethrough

    Build Coverage Downloads Size Sponsors Backers Chat

    mdast extensions to parse and serialize GFM strikethrough.

    Contents

    What is this?

    This package contains extensions that add support for the strikethrough syntax enabled by GFM to mdast-util-from-markdown and mdast-util-to-markdown.

    When to use this

    These tools are all rather low-level. In most cases, you’d want to use remark-gfm with remark instead.

    When you are working with syntax trees and want all of GFM, use mdast-util-gfm instead.

    When working with mdast-util-from-markdown, you must combine this package with micromark-extension-gfm-strikethrough.

    This utility does not handle how markdown is turned to HTML. That’s done by mdast-util-to-hast. If you want a different element, you should configure that utility.

    Install

    This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

    npm install mdast-util-gfm-strikethrough

    In Deno with esm.sh:

    import {gfmStrikethroughFromMarkdown, gfmStrikethroughToMarkdown} from 'https://esm.sh/mdast-util-gfm-strikethrough@1'

    In browsers with esm.sh:

    <script type="module">
      import {gfmStrikethroughFromMarkdown, gfmStrikethroughToMarkdown} from 'https://esm.sh/mdast-util-gfm-strikethrough@1?bundle'
    </script>

    Use

    Say our document example.md contains:

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

    …and our module example.js looks as follows:

    import fs from 'node:fs/promises'
    import {fromMarkdown} from 'mdast-util-from-markdown'
    import {toMarkdown} from 'mdast-util-to-markdown'
    import {gfmStrikethrough} from 'micromark-extension-gfm-strikethrough'
    import {gfmStrikethroughFromMarkdown, gfmStrikethroughToMarkdown} from 'mdast-util-gfm-strikethrough'
    
    const doc = await fs.readFile('example.md')
    
    const tree = fromMarkdown(doc, {
      extensions: [gfmStrikethrough()],
      mdastExtensions: [gfmStrikethroughFromMarkdown]
    })
    
    console.log(tree)
    
    const out = toMarkdown(tree, {extensions: [gfmStrikethroughToMarkdown]})
    
    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

    This package exports the identifiers gfmStrikethroughFromMarkdown and gfmStrikethroughToMarkdown. There is no default export.

    gfmStrikethroughFromMarkdown

    Extension for mdast-util-from-markdown.

    gfmStrikethroughToMarkdown

    Extension for mdast-util-to-markdown.

    Syntax tree

    The following interfaces are added to mdast by this utility.

    Nodes

    Delete

    interface Delete <: Parent {
      type: "delete"
      children: [TransparentContent]
    }

    Delete (Parent) represents contents that are no longer accurate or no longer relevant.

    Delete can be used where static phrasing content is expected. Its content model is transparent content.

    For example, the following markdown:

    ~~alpha~~

    Yields:

    {
      type: 'delete',
      children: [{type: 'text', value: 'alpha'}]
    }

    Content model

    StaticPhrasingContent (GFM strikethrough)

    type StaticPhrasingContentGfm = Delete | StaticPhrasingContent

    Types

    This package is fully typed with TypeScript. It does not export additional types.

    The Delete node type is supported in @types/mdast by default.

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    This plugin works with mdast-util-from-markdown version 1+ and mdast-util-to-markdown version 1+.

    Related

    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

    Install

    npm i mdast-util-gfm-strikethrough

    DownloadsWeekly Downloads

    924,458

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    14.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck