版本：3.5.2

MDX 和 React

Docusaurus 内置支持 MDX，允许您在 Markdown 文件中编写 JSX 并将其渲染为 React 组件。

查看 MDX 文档，了解您可以使用 MDX 做哪些奇妙的事情。

调试 MDX

MDX 格式非常严格，您可能会遇到编译错误。

使用 MDX 游乐场 调试它们并确保您的语法有效。

信息

Prettier，最流行的格式化程序，仅支持旧版 MDX v1。如果您得到意外的格式化结果，您可能需要在有问题的区域之前添加 {/* prettier-ignore */}，或者将 *.mdx 添加到您的 .prettierignore 中，直到 Prettier 正确支持 MDX v3。 MDX 的主要作者之一推荐使用带有 remark-mdx 的 remark-cli.

导出组件

要在 MDX 文件中定义任何自定义组件，您必须导出它：只有以 export 开头的段落将被解析为组件而不是散文。

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '2px',
      color: '#fff',
      padding: '0.2rem',
    }}>
    {children}
  </span>
);

<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.

I can write **Markdown** alongside my _JSX_!

请注意它如何渲染来自 React 组件的标记和 Markdown 语法

https://:3000

Docusaurus 绿色和 Facebook 蓝色是我最喜欢的颜色。

我可以将 Markdown 与我的 JSX 结合使用！

MDX 是 JSX

由于所有文档文件都使用 MDX 解析，因此任何看起来像 HTML 的东西实际上都是 JSX。因此，如果您需要内联样式化组件，请遵循 JSX 风格并提供样式对象。

/* Instead of this: */
<span style="background-color: red">Foo</span>
/* Use this: */
<span style={{backgroundColor: 'red'}}>Foo</span>

导入组件

您还可以导入在其他文件中定义的自己的组件或通过 npm 安装的第三方组件。

<!-- Docusaurus theme component -->
import TOCInline from '@theme/TOCInline';
<!-- External component -->
import Button from '@mui/material/Button';
<!-- Custom component -->
import BrowserWindow from '@site/src/components/BrowserWindow';

提示

@site 别名指向您的网站目录，通常是 docusaurus.config.js 文件所在的位置。使用别名而不是相对路径 ('../../src/components/BrowserWindow') 可以避免在移动文件时或在对文档进行版本控制和翻译时更新导入路径。

虽然在 Markdown 中声明组件对于简单情况非常方便，但由于有限的编辑器支持、解析错误的风险以及可重用性低，它变得难以维护。当您的组件涉及复杂的 JS 逻辑时，请使用单独的 .js 文件

src/components/Highlight.js
import React from 'react';

export default function Highlight({children, color}) {
  return (
    <span
      style={{
        backgroundColor: color,
        borderRadius: '2px',
        color: '#fff',
        padding: '0.2rem',
      }}>
      {children}
    </span>
  );
}

markdown-file.mdx
import Highlight from '@site/src/components/Highlight';

<Highlight color="#25c2a0">Docusaurus green</Highlight>

提示

如果您在许多文件中使用相同的组件，则无需在所有地方导入它——考虑将其添加到全局作用域。见下文

MDX 组件范围

除了导入组件和导出组件之外，在 MDX 中使用组件的第三种方法是 将其注册到全局作用域，这将使其在所有 MDX 文件中自动可用，无需任何导入语句。

例如，给定此 MDX 文件

- a
- list!

And some <Highlight>custom markup</Highlight>...

它将被编译为包含 ul、li、p 和 Highlight 元素的 React 组件。Highlight 不是本机 html 元素：您需要为其提供自己的 React 组件实现。

在 Docusaurus 中，MDX 组件范围由 @theme/MDXComponents 文件提供。它本身并不是一个 React 组件，与 @theme/ 别名下的大多数其他导出不同：它是一个来自 Highlight 等标签名称到其 React 组件实现的记录。

如果您 swizzle 此组件，您将找到所有已实现的标签，并且可以通过 swizzle 相关的子组件来进一步自定义我们的实现，例如 @theme/MDXComponents/Code（用于渲染 Markdown 代码块）。

如果您想注册额外的标签名称（如上面的 <Highlight> 标签），您应该考虑包装 @theme/MDXComponents，这样您就不必维护所有现有的映射。由于 swizzle CLI 还不允许包装非组件文件，因此您应该手动创建包装器

src/theme/MDXComponents.js
import React from 'react';
// Import the original mapper
import MDXComponents from '@theme-original/MDXComponents';
import Highlight from '@site/src/components/Highlight';

export default {
  // Re-use the default mapping
  ...MDXComponents,
  // Map the "<Highlight>" tag to our Highlight component
  // `Highlight` will receive all props that were passed to `<Highlight>` in MDX
  Highlight,
};

现在，您可以随意在每个页面中使用 <Highlight>，而无需编写导入语句

I can conveniently use <Highlight color="#25c2a0">Docusaurus green</Highlight> everywhere!

https://:3000

我可以方便地在所有地方使用 Docusaurus 绿色！

警告

我们故意使用大写标签名称，例如 Highlight。

从 MDX v3+ 开始（Docusaurus v3+），小写标签名称始终被渲染为本机 html 元素，并且不会使用您提供的任何组件映射。

警告

此功能由 MDXProvider 提供。如果您在 React 页面中导入 Markdown，您必须通过 MDXContent 主题组件自行提供此提供程序。

src/pages/index.js
import React from 'react';
import FeatureDisplay from './_featureDisplay.mdx';
import MDXContent from '@theme/MDXContent';

export default function LandingPage() {
  return (
    <div>
      <MDXContent>
        <FeatureDisplay />
      </MDXContent>
    </div>
  );
}

如果您没有将导入的 MDX 包裹在 MDXContent 中，则全局作用域将不可用。

Markdown 和 JSX 的互操作性

Docusaurus v3 正在使用 MDX v3。

The MDX 语法与 CommonMark 大致兼容，但更加严格，因为您的 .mdx 文件可以使用 JSX 并被编译成真正的 React 组件（查看游乐场）。

一些有效的 CommonMark 功能无法与 MDX 一起使用 (更多信息)，特别是

缩进代码块：使用三个反引号代替
自动链接 (<https://:3000>)：使用常规链接语法代替 ([https://:3000](https://:3000))
HTML 语法 (<p style="color: red;">)：使用 JSX 代替 (<p style={{color: 'red'}}>)
未转义的 { 和 <：使用 \ 代替转义它们 (\{ 和 \<)

实验性 CommonMark 支持

Docusaurus v3 使得您可以通过以下选项选择加入不太严格的标准 CommonMark 支持

format: md 前端 matter
.md 文件扩展名与 siteConfig.markdown.format: "detect" 配置结合使用

此功能是 实验性的，目前有一些限制。

导入代码片段

您不仅可以导入包含组件定义的文件，还可以将任何代码文件作为原始文本导入，然后使用 Webpack raw-loader 将其插入代码块中。为了使用raw-loader，您首先需要在项目中安装它。

npm
Yarn
pnpm

npm install --save raw-loader

yarn add raw-loader

pnpm add raw-loader

现在您可以像导入其他文件一样导入代码片段。

myMarkdownFile.mdx
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';

<CodeBlock language="jsx">{MyComponentSource}</CodeBlock>

https://:3000

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import React, {useState} from 'react';

export default function MyComponent() {
  const [bool, setBool] = useState(false);
  return (
    <div>
      <p>MyComponent rendered !</p>
      <p>bool={bool ? 'true' : 'false'}</p>
      <p>
        <button onClick={() => setBool((b) => !b)}>toggle bool</button>
      </p>
    </div>
  );
}

有关<CodeBlock>组件的更多详细信息，请参阅在 JSX 中使用代码块。

注意

您必须使用<CodeBlock>而不是 Markdown 三重反引号```，因为后者会将其内容按原样输出，而您希望在这里插入导入的文本。

警告

此功能处于实验阶段，将来可能会发生破坏性 API 更改。

导入 Markdown

您可以将 Markdown 文件用作组件，并在其他地方导入它们，无论是在 Markdown 文件中还是在 React 页面中。

按照惯例，使用_文件名前缀不会创建任何文档页面，这意味着 Markdown 文件是“部分”，由其他文件导入。

_markdown-partial-example.mdx
<span>Hello {props.name}</span>

This is text some content from `_markdown-partial-example.mdx`.

someOtherDoc.mdx
import PartialExample from './_markdown-partial-example.mdx';

<PartialExample name="Sebastien" />

https://:3000

HelloSebastien

这是来自_markdown-partial-example.md的一些内容。

这样，您可以在多个页面之间重复使用内容，避免重复材料。

可用导出

在 MDX 页面中，以下变量可用作全局变量。

frontMatter：前置 matter 作为字符串键和值的记录；
toc：目录，作为标题树。有关更具体的用例，另请参见内联目录。
contentTitle：Markdown 标题，即 Markdown 文本中的第一个h1标题。如果没有（例如在 front matter 中指定了标题），则为undefined。

import TOCInline from '@theme/TOCInline';
import CodeBlock from '@theme/CodeBlock';

The table of contents for this page, serialized:

<CodeBlock className="language-json">{JSON.stringify(toc, null, 2)}</CodeBlock>

The front matter of this page:

<ul>
  {Object.entries(frontMatter).map(([key, value]) => <li key={key}><b>{key}</b>: {value}</li>)}
</ul>

<p>The title of this page is: <b>{contentTitle}</b></p>

https://:3000

此页面的目录，序列化

[
  {
    "value": "Exporting components",
    "id": "exporting-components",
    "level": 3
  },
  {
    "value": "Importing components",
    "id": "importing-components",
    "level": 3
  },
  {
    "value": "MDX component scope",
    "id": "mdx-component-scope",
    "level": 3
  },
  {
    "value": "Markdown and JSX interoperability",
    "id": "markdown-and-jsx-interoperability",
    "level": 3
  },
  {
    "value": "Importing code snippets",
    "id": "importing-code-snippets",
    "level": 2
  },
  {
    "value": "Importing Markdown",
    "id": "importing-markdown",
    "level": 2
  },
  {
    "value": "Available exports",
    "id": "available-exports",
    "level": 2
  }
]

此页面的 front matter

id: react
description: 借助 MDX 在 Docusaurus Markdown 文档中使用 React 的强大功能
slug: /markdown-features/react

此页面的标题为：MDX 和 React

导出组件​

导入组件​

MDX 组件范围​

Markdown 和 JSX 的互操作性​

导入代码片段​

导入 Markdown​

可用导出​

导出组件

导入组件

MDX 组件范围

Markdown 和 JSX 的互操作性

导入代码片段

导入 Markdown

可用导出