mirror of https://github.com/facebook/docusaurus.git synced 2025-05-01 19:27:48 +02:00

docs(v2): Add READMEs to v2 packages (#4034 )

* docs(v2): Add READMEs to v2 packages

Signed-off-by: Reece Dunham <me@rdil.rocks>

* Update packages/docusaurus-remark-plugin-npm2yarn/package.json

* Update packages/docusaurus/README.md

* Update packages/docusaurus-plugin-sitemap/README.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

2021-01-14 17:16:26 +01:00

729 B

Raw Blame History

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

729 B Raw Blame History

@docusaurus/mdx-loader