Rspress plugin to render mermaid diagrams
npm install rspress-plugin-mermaid为 Rspress 支持基于 Mermaid 的流程图、时序图等图表。
编写 Mermaid 图表时,只需使用 mermaid 代码块,插件会自动将其转换为 SVG。
```markdown`mermaid`
flowchart TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]``

`bash`
npm i rspress-plugin-mermaid
pnpm add rspress-plugin-mermaid
`ts
import * as path from 'path';
import { defineConfig } from 'rspress/config';
import mermaid from 'rspress-plugin-mermaid';
export default defineConfig({
root: path.join(__dirname, 'docs'),
plugins: [mermaid()],
});
`
Mermaid 配置选项,将传递给 mermaid.initialize 函数。查看 mermaid 文档 了解更多细节。
- Type: object
`ts
import * as path from 'path';
import { defineConfig } from 'rspress/config';
import mermaid from 'rspress-plugin-mermaid';
export default defineConfig({
root: path.join(__dirname, 'docs'),
plugins: [
mermaid({
mermaidConfig: {
theme: 'forest',
},
}),
],
});
``