@mdx-js/loader
v3.1.0
Published
Webpack loader for MDX
Downloads
2,636,262
Readme
@mdx-js/loader
webpack loader for MDX.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Examples
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is a webpack loader to support MDX.
When should I use this?
This integration is useful if you’re using webpack (or another tool that uses webpack, such as Next.js or Rspack).
This integration can be combined with the Babel loader 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/loader
Use
Add something along these lines to your webpack.config.js
:
/**
* @import {Options} from '@mdx-js/loader'
* @import {Configuration} from 'webpack'
*/
/** @type {Configuration} */
const webpackConfig = {
module: {
// …
rules: [
// …
{
test: /\.mdx?$/,
use: [
{
loader: '@mdx-js/loader',
/** @type {Options} */
options: {/* jsxImportSource: …, otherOptions… */}
}
]
}
]
}
}
export default webpackConfig
See also ¶ Next.js and ¶ Vue CLI, if you’re using webpack through them, for more info.
API
This package exports no identifiers.
The default export is mdx
.
mdx
This package exports a webpack plugin as the default export.
Configuration (see Options
) are passed separately through
webpack.
Options
Configuration (TypeScript type).
Options are the same as CompileOptions
from @mdx-js/mdx
with the exception that the SourceMapGenerator
and development
options are
supported based on how you configure webpack.
You cannot pass them manually.
Examples
Combine with Babel
If you use modern JavaScript features you might want to use Babel through
babel-loader
to compile to code that works in older browsers:
/**
* @import {Options} from '@mdx-js/loader'
* @import {Configuration} from 'webpack'
*/
/** @type {Configuration} */
const webpackConfig = {
module: {
// …
rules: [
// …
{
test: /\.mdx?$/,
use: [
// Note that Webpack runs right-to-left: `@mdx-js/loader` is used first, then
// `babel-loader`.
{loader: 'babel-loader', options: {}},
{
loader: '@mdx-js/loader',
/** @type {Options} */
options: {}
}
]
}
]
}
}
export default webpackConfig
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/loader@^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.