@mdx-js/rollup

@mdx-js/rollup

Rollup plugin for MDX.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
• Security
• Contribute
• License

What is this?

This package is a Rollup 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 support nonstandard JSX runtimes (such as Vue) or 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: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install @mdx-js/rollup

yarn:

yarn add @mdx-js/rollup

Use

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

import mdx from '@mdx-js/rollup'

export default {
  // …
  plugins: [
    // …
    mdx({/* Options… */})
  ]
}

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

API

This package exports a Rollup plugin as the default export.

Source maps are supported based on how you configure Rollup. You do not need to pass options.SourceMapGenerator.

options

options are the same as compile from @mdx-js/mdx, with the additions of:

options.include

options.exclude

List of picomatch patterns to include and/or exclude (string, RegExp, Array<string|RegExp>, default: []).

Note: Babel

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

// …
import {babel} from '@rollup/plugin-babel'

export default {
  // …
  plugins: [
    // …
    mdx({/* Options… */}),
    babel({
      // Also run on what used to be `.mdx` (but is now JS):
      extensions: ['.js', '.jsx', '.cjs', '.mjs', '.md', '.mdx'],
      // Other options…
    })
  ]
}

Types

This package is fully typed with TypeScript. See § Types on our website for information.

An Options type is exported, which represents acceptable configuration.

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.

License

MIT © Titus Wormer