docusaurus/packages/docusaurus-mdx-loader/README.md
Sébastien Lorber 9ecff801ff
Some checks are pending
Argos CI / take-screenshots (push) Waiting to run
Build Hash Router / Build Hash Router (push) Waiting to run
Canary Release / Publish Canary (push) Waiting to run
CodeQL / Analyze (javascript) (push) Waiting to run
Continuous Releases / Continuous Releases (push) Waiting to run
E2E Tests / E2E — Yarn v1 (18.0) (push) Waiting to run
E2E Tests / E2E — Yarn v1 (20) (push) Waiting to run
E2E Tests / E2E — Yarn v1 (22) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (node-modules, -s) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (node-modules, -st) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (pnp, -s) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (pnp, -st) (push) Waiting to run
E2E Tests / E2E — npm (push) Waiting to run
E2E Tests / E2E — pnpm (push) Waiting to run
refactor: create `@docusaurus/bundler` and `@docusaurus/babel` packages (#10511)
2024-09-21 16:35:49 +02:00

59 lines
966 B
Markdown

# `@docusaurus/mdx-loader`
Docusaurus webpack loader for [MDX](https://github.com/mdx-js/mdx).
## Installation
```sh
yarn add @docusaurus/mdx-loader
```
## Usage
```js
// ...
module: {
rules: [
// ...
{
test: /\.mdx?$/,
use: [
{
loader: '@docusaurus/mdx-loader',
options: {
// .. See options
},
},
],
},
];
}
```
## Options
### `rehypePlugins`
Array of rehype plugins to manipulate the MDXHAST
### `remarkPlugins`
Array of remark plugins to manipulate the MDXAST
### `metadataPath`
A function to provide the metadataPath depending on current loaded MDX path that will be exported as the MDX metadata.
### `markdownConfig`
The global Docusaurus Markdown config (`config.markdown`), that plugin authors should forward:
```js
const loader = {
loader: require.resolve('@docusaurus/mdx-loader'),
options: {
markdownConfig: siteConfig.markdown,
},
};
```