@mdx-js/rollup

核心软件包 / @mdx-js/rollup

2-3 minutes read

`@mdx-js/rollup`

Rollup (and Vite) plugin for MDX.

What is this?
When should I use this?
Install
Use
API
- mdx(options?)
- Options
Examples
- Combine with Babel
Types
Compatibility
Security
Contribute
License

What 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 only. In Node.js (version 16+), install with npm:

Shell

npm install @mdx-js/rollup

Use

Add something along these lines to your rollup.config.js:

TypeScript

/**
 * @import {RollupOptions} from 'rollup'
 */

import mdx from '@mdx-js/rollup'

/** @type {RollupOptions} */
const config = {
  // …
  plugins: [
    // …
    mdx({/* jsxImportSource: …, otherOptions… */})
  ]
}

export default config

See also ¶ Vite if you’re using Rollup through them for more info.

API

This package exports no identifiers. The default export is mdx.

`mdx(options?)`

Plugin to compile MDX w/ rollup.

Parameters

options (Options, optional) — configuration

Returns

Rollup (and Vite) plugin.

`Options`

Configuration (TypeScript type).

Options are the same as CompileOptions from @mdx-js/mdx 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, or string, optional) — picomatch patterns to exclude
include (Array<RegExp | string>, RegExp, or string, optional) — picomatch patterns to include

Examples

Combine with Babel

If you use modern JavaScript features you might want to use Babel through @rollup/plugin-babel to compile to code that works:

TypeScript

/**
 * @import {RollupOptions} from 'rollup'
 */

import mdx from '@mdx-js/rollup'
import {babel} from '@rollup/plugin-babel'

/** @type {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 type Options. See § Types 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 § Security on our website for information.

Contribute

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.

Contents