mdast-util-bracketed-spans

A collection of extensions that provide support for pandoc-style bracketed spans. This package provides:

• bracketedSpanFromMarkdown An extension for mdast-util-from-markdown
• bracketedSpanToMarkdown An extension for mdast-util-to-markdown
• bracketedSpanToMarkdown An extension for mdast-util-to-hast

Using remark? You probably shouldn't use this package directly, but instead use remark-bracketed-spans-2.

Usage

1import { fromMarkdown } from "mdast-util-from-markdown";
2import { toMarkdown } from "mdast-util-to-markdown";
3import { toHast } from "mdast-util-to-hast";
4import { toHtml } from "hast-util-to-html";
5import { bracketedSpanSyntax } from "micromark-extension-bracketed-spans";
6import { bracketedSpanFromMarkdown } from "mdast-util-bracketed-spans";
7import { bracketedSpanToMarkdown } from "mdast-util-bracketed-spans";
8import { bracketedSpanToHast } from "mdast-util-bracketed-spans";
9
10const input = '[This is some text]{#id .cls key="value"}';
11
12const mdast = fromMarkdown(input, "utf-8", {
13  extensions: [bracketedSpanSyntax()],
14  mdastExtensions: [bracketedSpanFromMarkdown()],
15});
16
17const markdown = toMarkdown(mdast, {
18  extensions: [bracketedSpanToMarkdown()],
19});
20console.log(markdown);
21// '[This is some text]{#id .cls key="value"}'
22
23const hast = toHtml(mdast, {
24  handlers: {
25    bracketedSpan: bracketedSpanToHast,
26  },
27});
28
29const html = toHtml(hast);
30console.log(html);
31// <p><span id="a">This is <em>some text</em></span></p>