图表

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

安装

npm

npm install --save @docusaurus/theme-mermaid

Yarn

yarn add @docusaurus/theme-mermaid

pnpm

pnpm add @docusaurus/theme-mermaid

通过添加插件 @docusaurus/theme-mermaid 并在 docusaurus.config.js 中将 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;`}
/>