docusaurus/packages/docusaurus-mdx-loader
Joshua Chen 1bec5f673a
chore: upgrade dependencies (#7436)
2022-05-17 13:11:20 +08:00
..
src chore: enable import/order rule (#7418) 2022-05-14 23:39:50 +08:00
.npmignore misc: convert all internal scripts to ESM (#6286) 2022-01-08 12:59:28 +08:00
README.md
package.json chore: upgrade dependencies (#7436) 2022-05-17 13:11:20 +08:00
tsconfig.json refactor(types): move non-core, non-public types out of the types package (#7293) 2022-05-03 17:15:48 +08:00

README.md

@docusaurus/mdx-loader

Docusaurus webpack loader for MDX.

Installation

yarn add @docusaurus/mdx-loader

Usage

// ...
module: {
  rules: [
    // ...
    {
      test: /\.mdx?$/,
      use: [
        'babel-loader',
        {
          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.