@mdx-js/rollup
Rollup (and Vite) plugin for MDX.
Contents
mdx(options?)
Options
Combine with BabelWhat is this?
This package is a Rollup (and Vite) plugin to support MDX.When should I use this?
This integration is useful if you’re using Rollup (or another tool that uses Rollup, such as Vite).This integration can be combined with the Babel plugin to compile modern JavaScript features to ones your users support.
If you want to evaluate MDX code then the lower-level compiler (
@mdx-js/mdx
)
can be used manually.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install @mdx-js/rollup
Use
Add something along these lines to yourrollup.config.js
:import mdx from '@mdx-js/rollup'
/** @type {import('rollup').RollupOptions} */
const config = {
// …
plugins: [
// …
mdx({/* jsxImportSource: …, otherOptions… */})
]
}
export default config
See also ¶ Vitevite if you’re using Rollup through them for more info.
API
This package exports no identifiers. The default export ismdx
api-mdx.mdx(options?)
Plugin to compile MDX w/ rollup.Parameters
options
(Options
api-options, optional)
Returns
Rollup (and Vite) plugin.Options
Configuration (TypeScript type).Options are the same as
CompileOptions
from @mdx-js/mdx
compile-options
with the exception that the SourceMapGenerator
option is supported based on
how you configure Rollup.
You cannot pass it manually.
When using Vite, the development
option is also supported based on how you
configure Vite.There are also two additional options:
Fields
exclude
(Array<RegExp | string>
,RegExp
, orstring
, optional)
include
(Array<RegExp | string>
,RegExp
, orstring
, optional)
Examples
Combine with Babel
If you use modern JavaScript features you might want to use Babel through@rollup/plugin-babel
rollup-plugin-babel to compile to code that works:import mdx from '@mdx-js/rollup'
import {babel} from '@rollup/plugin-babel'
/** @type {import('rollup').RollupOptions} */
const config = {
// …
plugins: [
// …
mdx({/* jsxImportSource: …, otherOptions… */}),
babel({
// Also run on what used to be `.mdx` (but is now JS):
extensions: ['.js', '.jsx', '.cjs', '.mjs', '.md', '.mdx']
// Other options…
})
]
}
export default config
Types
This package is fully typed with TypeScript. It exports the additional typeOptions
api-options.
See § Typestypes on our website for information.Compatibility
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,
@mdx-js/rollup@^3
,
compatible with Node.js 16.Security
See § Securitysecurity on our website for information.Contribute
See § Contributecontribute on our website for ways to get started. See § Supportsupport for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.