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

    2.0.0 • Public • Published

    mdast-util-gfm

    Build Coverage Downloads Size Sponsors Backers Chat

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

    When to use this

    Use this if you’re dealing with the AST manually and need all of GFM. It’s probably nicer to use remark-gfm with remark, which includes this but provides a nicer interface and makes it easier to combine with hundreds of plugins.

    Alternatively, the extensions can be used separately:

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install mdast-util-gfm

    Use

    Say we have the following file, example.md:

    # GFM
    
    ## Autolink literals
    
    www.example.com, https://example.com, and contact@example.com.
    
    ## Footnote
    
    A note[^1]
    
    [^1]: Big note.
    
    ## Strikethrough
    
    ~one~ or ~~two~~ tildes.
    
    ## Table
    
    | a | b  |  c |  d  |
    | - | :- | -: | :-: |
    
    ## Tasklist
    
    * [ ] to do
    * [x] done

    And our module, example.js, looks as follows:

    import fs from 'node:fs'
    import {fromMarkdown} from 'mdast-util-from-markdown'
    import {toMarkdown} from 'mdast-util-to-markdown'
    import {gfm} from 'micromark-extension-gfm'
    import {gfmFromMarkdown, gfmToMarkdown} from 'mdast-util-gfm'
    
    const doc = fs.readFileSync('example.md')
    
    const tree = fromMarkdown(doc, {
      extensions: [gfm()],
      mdastExtensions: [gfmFromMarkdown()]
    })
    
    console.log(tree)
    
    const out = toMarkdown(tree, {extensions: [gfmToMarkdown()]})
    
    console.log(out)

    Now, running node example yields:

    {
      type: 'root',
      children: [
        {type: 'heading', depth: 1, children: [{type: 'text', value: 'GFM'}]},
        {
          type: 'heading',
          depth: 2,
          children: [{type: 'text', value: 'Autolink literals'}]
        },
        {
          type: 'paragraph',
          children: [
            {
              type: 'link',
              title: null,
              url: 'http://www.example.com',
              children: [{type: 'text', value: 'www.example.com'}]
            },
            {type: 'text', value: ', '},
            {
              type: 'link',
              title: null,
              url: 'https://example.com',
              children: [{type: 'text', value: 'https://example.com'}]
            },
            {type: 'text', value: ', and '},
            {
              type: 'link',
              title: null,
              url: 'mailto:contact@example.com',
              children: [{type: 'text', value: 'contact@example.com'}]
            },
            {type: 'text', value: '.'}
          ]
        },
        {type: 'heading', depth: 2, children: [{type: 'text', value: 'Footnote'}]},
        {
          type: 'paragraph',
          children: [
            {type: 'text', value: 'A note'},
            {type: 'footnoteReference', identifier: '1', label: '1'}
          ]
        },
        {
          type: 'footnoteDefinition',
          identifier: '1',
          label: '1',
          children: [
            {type: 'paragraph', children: [{type: 'text', value: 'Big note.'}]}
          ]
        },
        {
          type: 'heading',
          depth: 2,
          children: [{type: 'text', value: 'Strikethrough'}]
        },
        {
          type: 'paragraph',
          children: [
            {
              type: 'delete',
              children: [{type: 'text', value: 'one'}]
            },
            {type: 'text', value: ' or '},
            {
              type: 'delete',
              children: [{type: 'text', value: 'two'}]
            },
            {type: 'text', value: ' tildes.'}
          ]
        },
        {type: 'heading', depth: 2, children: [{type: 'text', value: 'Table'}]},
        {
          type: 'table',
          align: [null, 'left', 'right', 'center'],
          children: [
            {
              type: 'tableRow',
              children: [
                {type: 'tableCell', children: [{type: 'text', value: 'a'}]},
                {type: 'tableCell', children: [{type: 'text', value: 'b'}]},
                {type: 'tableCell', children: [{type: 'text', value: 'c'}]},
                {type: 'tableCell', children: [{type: 'text', value: 'd'}]}
              ]
            }
          ]
        },
        {type: 'heading', depth: 2, children: [{type: 'text', value: 'Tasklist'}]},
        {
          type: 'list',
          ordered: false,
          start: null,
          spread: false,
          children: [
            {
              type: 'listItem',
              spread: false,
              checked: false,
              children: [
                {type: 'paragraph', children: [{type: 'text', value: 'to do'}]}
              ]
            },
            {
              type: 'listItem',
              spread: false,
              checked: true,
              children: [
                {type: 'paragraph', children: [{type: 'text', value: 'done'}]}
              ]
            }
          ]
        }
      ]
    }
    # GFM
    
    ## Autolink literals
    
    [www.example.com](http://www.example.com), <https://example.com>, and <contact@example.com>.
    
    ## Footnote
    
    A note[^1]
    
    [^1]: Big note.
    
    ## Strikethrough
    
    ~~one~~ or ~~two~~ tildes.
    
    ## Table
    
    | a | b  |  c |  d  |
    | - | :- | -: | :-: |
    
    ## Tasklist
    
    *   [ ] to do
    *   [x] done

    API

    This package exports the following identifiers: gfmFromMarkdown, gfmToMarkdown. There is no default export.

    gfmFromMarkdown()

    gfmToMarkdown(options?)

    Support GFM. The export of fromMarkdown is a function that can be called and returns an extension for mdast-util-from-markdown. The export of toMarkdown is a function that can be called with options and returns an extension for mdast-util-to-markdown.

    options

    Passed as options to mdast-util-gfm-table.

    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

    DownloadsWeekly Downloads

    414,835

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    14.8 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck