remark-deflist

remark-deflist

Remark plugin for adding support for pandoc-style definition lists to Markdown.

Adds three new node types to MDAST: descriptionlist, descriptionterm, and descriptiondetails. When using rehype, these will be stringified as dl, dt, and dd respectively.

Multi-line definitions are not supported.

Syntax

Term 1

: Definition 1

AST

The example above will yield:

{
  type: 'descriptionlist',
  children: [
    {
      type: 'descriptionterm',
      children: [{
        type: 'text',
        value: 'Term 1'
      }]
    },
    {
      type: 'descriptiondetails',
      children: [{
        type: 'text',
        value: 'Definition 1'
      }]
    }
  ]
}

Installation

npm install --save remark-deflist

Usage

import unified from 'unified'
import markdown from 'remark-parse'
import html from 'rehype-stringify'
import remark2rehype from 'remark-rehype'
import deflist from 'remark-deflist'

unified()
  .use(markdown)
  .use(deflist)
  .use(remark2rehype)
  .use(html)

License

MIT © Alex Shaw