Package Exports

@docusaurus/mdx-loader
@docusaurus/mdx-loader/lib/index.js
@docusaurus/mdx-loader/lib/remark/admonitions
@docusaurus/mdx-loader/lib/remark/admonitions/index.js
@docusaurus/mdx-loader/lib/remark/headings
@docusaurus/mdx-loader/lib/remark/headings/index.js
@docusaurus/mdx-loader/lib/remark/mermaid
@docusaurus/mdx-loader/lib/remark/mermaid/index.js
@docusaurus/mdx-loader/lib/remark/toc
@docusaurus/mdx-loader/lib/remark/toc/index.js
@docusaurus/mdx-loader/lib/remark/unwrapMdxCodeBlocks
@docusaurus/mdx-loader/lib/remark/unwrapMdxCodeBlocks/index.js
@docusaurus/mdx-loader/lib/remark/utils
@docusaurus/mdx-loader/lib/remark/utils/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@docusaurus/mdx-loader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

`markdownConfig`

The global Docusaurus Markdown config (config.markdown), that plugin authors should forward:

const loader = {
  loader: require.resolve('@docusaurus/mdx-loader'),
  options: {
    markdownConfig: siteConfig.markdown,
  },
};