跳到主要内容

图表

可以使用 Mermaid 在代码块中渲染图表。

安装​

npm install --save @docusaurus/theme-mermaid

通过在 docusaurus.config.js 中添加插件 @docusaurus/theme-mermaid 并将 markdown.mermaid 设置为 true 来启用 Mermaid 功能。

docusaurus.config.js
export default {
  markdown: {
    mermaid: true,
  },
  themes: ['@docusaurus/theme-mermaid'],
};

使用方法​

添加一个语言为 mermaid 的代码块：

示例 Mermaid 图表
```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

请参阅 Mermaid 语法文档以获取有关 Mermaid 语法的更多信息。

主题​

可以通过在 docusaurus.config.js 的 themeConfig 中设置 mermaid.theme 值来更改图表的深色和浅色主题。您可以为浅色和深色模式设置不同的主题。

docusaurus.config.js
export default {
  themeConfig: {
    mermaid: {
      theme: {light: 'neutral', dark: 'forest'},
    },
  },
};

请参阅 Mermaid 主题文档以获取有关 Mermaid 图表主题的更多信息。

Mermaid 配置​

mermaid.options 中的选项将直接传递给 mermaid.initialize：

docusaurus.config.js
export default {
  themeConfig: {
    mermaid: {
      options: {
        maxTextSize: 50,
      },
    },
  },
};

请参阅 Mermaid 配置文档和 Mermaid 配置类型以了解可用的配置选项。

动态 Mermaid 组件​

要生成动态图表，您可以使用 Mermaid 组件：

动态 Mermaid 组件示例
import Mermaid from '@theme/Mermaid';

<Mermaid
  value={`graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;`}
/>