hast-util-definition-list

hast-util-to-mdast handlers for definition list

Feature

This package provides hast-util-to-mdast handlers converting dl, dt, dd hast nodes into mdast elements compatible with mdast-util-definition-list.

Install

From npm:

1$ npm install hast-util-definition-list

API

Export hast-util-to-mdast's handler (Handle) and handlers (Record<string, Handle>).

• defListHastToMdast (type: Record<"dl"|"dt"|"dd", Handle>)
• dl (type: Handle)
• dt (type: Handle)
• dd (type: Handle)

Use

1import { defListHastToMdast } from "hast-util-definition-list";
2
3import { fromHtml as hastFromHtml } from "hast-util-from-html";
4import { toMarkdown as mdastToMarkdown } from "mdast-util-to-markdown";
5import { toMdast as hastToMdast } from "hast-util-to-mdast";
6import { defListToMarkdown } from "mdast-util-definition-list";
7
8const html = `
9<p>This is paragraph.</p>
10<dl>
11<dt>First Term</dt>
12<dd>This is the <strong>definition</strong> of the first term.</dd>
13<dd>This is another definition of the first term.</dd>
14<dt>Second Term</dt>
15<dd>This is one definition of the second term.</dd>
16<dd>This is another definition of the second term.</dd>
17</dl>`;
18
19const hast = hastFromHtml(html, { fragment: true });
20const mdast = hastToMdast(hast, {
21  handlers: {
22    ...defListHastToMdast,
23  },
24});
25const md = mdastToMarkdown(mdast, {
26  extensions: [defListToMarkdown],
27});
28 
29console.log(md);
30// output =>
31//
32//  This is paragraph.
33//
34//  First Term
35//  :   This is the **definition** of the first term.
36//  :   This is another definition of the first term.
37//
38//  Second Term
39//  :   This is one definition of the second term.
40//  :   This is another definition of the second term.