remark plugin to support the MDX syntax (JSX, export/import, expressions).
This package is a unified (remark ) plugin to enable the extensions to markdown that MDX adds: JSX (<x/>), export/import (export x from 'y'), and expression {{1 + 1}}. You can use this plugin to add support for parsing and serializing them.
This plugin does not handle how MDX is compiled to JavaScript or evaluated and rendered to HTML. That’s done by @mdx-js/mdx
This plugin is useful if you’re dealing with the MDX syntax and integrating with remark, rehype, and the rest of unified. Some example use cases are when you want to lint the syntax or compile it to something other that JavaScript.
If you don’t use plugins and want to access the syntax tree, you can use mdast-util-from-markdownmdast-util-mdx
Typically though, you’d want to move a layer up: @mdx-js/mdx. That package is the core compiler for turning MDX into JavaScript which gives you the most control. Or even higher: if you’re using a bundler (Rollup, esbuild, webpack), or a site builder (Next.js) or build system (Vite) which comes with a bundler, you’re better off using an integration: see § Integrations .
This package is ESM only . In Node.js (version 16+), install with npm :
Shell
npm install remark-mdx
In Deno with esm.sh
TypeScript
import remarkMdx from ' https://esm.sh/remark-mdx@3' In browsers with esm.sh
HTML
<script type =" module" import remarkMdx from ' https://esm.sh/remark-mdx@3?bundle' script >
TypeScript
import {remark } from ' remark' import remarkMdx from ' remark-mdx' const file = await remark ()
.use (remarkMdx )
.process (' import a from "b"\n\n a <b /> c {1 + 1} d' console .log (String (file ))
MDX
import a from " b" b /> c { 1 + 1 } d
; and expressions: {1 + 1}).options (OptionsNothing (undefined).
OptionsConfiguration (TypeScript type).
acornOptions (AcornOptions{ecmaVersion: 2024, locations: true, sourceType: 'module'}) — configuration for acorn; all fields except locations can be setprintWidth (number, default: Infinity) — try and wrap syntax at this width; when set to a finite number (say, 80), the formatter will print attributes on separate lines when a tag doesn’t fit on one line; the normal behavior is to print attributes with spaces between them instead of line endingsquote ('"' or "'", default: '"') — preferred quote to use around attribute valuesquoteSmart (boolean, default: false) — use the other quote if that results in less bytestightSelfClosing (boolean, default: false) — do not use an extra space when closing self-closing elements: <img/> instead of <img />For recommendations on how to author MDX, see each corresponding readme:
MDX has no representation in HTML. Though, when you are dealing with MDX, you will likely go through hast. You can enable passing MDX through to hast by configuring remark-rehypepassThrough: ['mdxjsEsm', 'mdxFlowExpression', 'mdxJsxFlowElement', 'mdxJsxTextElement', 'mdxTextExpression'].
For info on the syntax of these features, see each corresponding readme:
For info on the syntax tree 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 the additional type Options
If you’re working with the syntax tree, you can register the new node types with @types/mdast by adding a reference:
TypeScript
// Register MDX nodes in mdast:
/// < reference types = " remark-mdx " />
/**
* @import {Root} from 'mdast'
*/
import {visit } from ' unist-util-visit' function myRemarkPlugin () {
/**
* @param {Root} tree
* Tree.
* @returns {undefined}
* Nothing.
*/
return function (tree ) {
visit (tree , function (node ) {
console .log (node ) // `node` can now be one of the MDX nodes.
})
}
}
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, remark-mdx@^3, compatible with Node.js 16.
See § Security on our website for information.
See § Contribute on our website for ways to get started. See § Support 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
Ceasefire now! 🕊️
Skip to content Docs What is MDX? Getting started Using MDX Extending MDX Troubleshooting MDX Guides GitHub flavored markdown (GFM) Frontmatter Math Syntax highlighting Embed MDX on demand Injecting components Packages @mdx-js/esbuild @mdx-js/loader @mdx-js/mdx @mdx-js/node-loader @mdx-js/preact @mdx-js/react @mdx-js/rollup @mdx-js/vue remark-mdx Components Playground Community Support Contribute Sponsor About Projects Blog GitHub OpenCollective