micromark extensions to support MDX, unaware of JavaScript.

• What is this?
• When to use this
• Install
• Use
• API
  • mdx()
• Authoring
• Syntax
• Errors
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package contains an extension that adds support for the syntax enabled by MDX to micromark. This extension is used inside MDX. It supports expressions, JSX, and turns some markdown features off. It is not aware of the syntax of JavaScript inside expressions and does not support export/imports.

You can use this extension when you are working with micromark.

This project is useful when you want to support MDX, unaware of JavaScript, for example because expressions can include Rust or variables or whatnot. If you want to be aware of JavaScript, use micromark-extension-mdxjs.

Alternatively, you can also use the underlying syntax extensions separately:

• micromark-extension-mdx-expression — support MDX expressions
• micromark-extension-mdx-jsx — support MDX JSX
• micromark-extension-mdx-md — turn some CommonMark features off

When you need a syntax tree, combine this package with mdast-util-mdx.

All these packages are used in remark-mdx, which focusses on making it easier to transform content by abstracting these internals away.

This package is ESM only. In Node.js (version 16+), install with npm:

npm install micromark-extension-mdx

In Deno with esm.sh:

import {mdx} from 'https://esm.sh/micromark-extension-mdx@2'

In browsers with esm.sh:

<script type="module">
  import {mdx} from 'https://esm.sh/micromark-extension-mdx@2?bundle'
</script>

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 useless: go to a syntax tree with mdast-util-from-markdown and mdast-util-mdx instead.

This package exports the identifier mdx. There is no default export.

The separate extensions support the development condition. Run node --conditions development module.js to get instrumented dev code. Without this condition, production code is loaded.

Create an extension for micromark to enable MDX syntax, unaware of JavaScript.

Extension for micromark that can be passed in extensions to enable MDX syntax, unaware of JavaScript (Extension).

For recommendations on how to author MDX, see each corresponding readme:

• expressions
• JSX
• CommonMark features not in MDX

For info on the syntax of these features, see each corresponding readme:

• expressions
• JSX
• CommonMark features not in MDX: n/a

For info on what errors are thrown, see each corresponding readme:

• expressions
• JSX
• CommonMark features not in MDX: n/a

This package is fully typed with TypeScript. It exports no additional types.

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, micromark-extension-mdx@^2, compatible with Node.js 16.

This package works with micromark version 3 and later.

This package is safe.

• micromark-extension-mdxjs — support MDX aware of JS
• mdast-util-mdx — support MDX in mdast
• remark-mdx — support MDX syntax in remark

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.

MIT © Titus Wormer