micromark-extension-mdx

micromark extension to support MDX (agnostic to JS). Use micromark-extension-mdxjs instead to support MDX.js.

This package provides the low-level modules for integrating with the micromark tokenizer but has no handling of compiling to HTML: go to a syntax tree instead.

When to use this

You should probably use micromark-extension-mdxjs instead, which supports JavaScript. Alternatively, if you don’t want JavaScript-aware parsing, use this package.

If you don’t need all of MDX, the extensions can be used separately:

• micromark/micromark-extension-mdx-expression — support MDX (or MDX.js) expressions
• micromark/micromark-extension-mdx-jsx — support MDX (or MDX.js) JSX
• micromark/micromark-extension-mdx-md — turn some markdown features off for MDX (or MDX.js)

Install

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

npm:

npm install micromark-extension-mdx

Use

import {micromark} from 'micromark'
import {mdx} from 'micromark-extension-mdx'

const output = micromark('a <b /> c {1 + 1} d', {extensions: [mdx()]})

console.log(output)

Yields:

<p>a  c  d</p>

…which is rather useless: go to a syntax tree with mdast-util-from-markdown and mdast-util-mdx instead.

API

This package exports the following identifiers: mdx. There is no default export.

mdx()

A function that can be called which returns an extension for micromark to parse MDX (can be passed in extensions). There are no options yet.

Related

• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-mdxjs — micromark extension to support MDX.js
• micromark/micromark-extension-mdx-expression — micromark extension to support MDX (or MDX.js) expressions
• micromark/micromark-extension-mdx-jsx — micromark extension to support MDX (or MDX.js) JSX
• micromark/micromark-extension-mdx-md — micromark extension to support misc MDX changes
• syntax-tree/mdast-util-mdx — mdast utility to support MDX (or MDX.js)

Contribute

See contributing.md in micromark/.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