Project: micromark/micromark-extension-mdx

Package: micromark-extension-mdx@1.0.0

  1. Dependents: 0
  2. micromark extension to support MDX (agnostic to JavaScript)
  1. unified 184
  2. markdown 162
  3. mdx 39
  4. micromark 37
  5. jsx 20
  6. micromark-extension 17
  7. expression 8


Build Coverage Downloads Size Sponsors Backers Chat

micromark extensions to support MDX, unaware of JavaScript.


What is this?

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.

When to use this

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:

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@1'

In browsers with esm.sh:

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


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

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



<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:


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


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


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


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 16+. Our projects sometimes work with older versions, but this is not guaranteed.

These extensions work with micromark version 3+.


This package is safe.


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