npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mdx-js/rollup

v3.0.1

Published

Rollup plugin for MDX

Downloads

186,178

Readme

@mdx-js/rollup

Build Coverage Downloads Sponsors Backers Chat

Rollup (and Vite) plugin for MDX.

Contents

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:

npm install @mdx-js/rollup

Use

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

import mdx from '@mdx-js/rollup'

/** @type {import('rollup').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:

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

License

MIT © Titus Wormer