启用
Mermaid 默认关闭。
安装依赖
pnpm add mermaid dompurify
npm install mermaid dompurify
yarn add mermaid dompurify
bun add mermaid dompurify
开启功能开关
nuxt.config.ts
export default defineNuxtConfig({
extends: ['@movk/nuxt-docs'],
movkNuxtDocs: {
mermaid: true
}
})
用法
用语言为 mermaid 的代码块编写图表:
Loading diagram...
```mermaid
flowchart LR
A[编写 Markdown] --> B{包含 MDC 组件?}
B -->|是| C[渲染 Vue 组件]
B -->|否| D[渲染 Prose 元素]
C --> E[输出页面]
D --> E
```
- 跟随站点亮暗模式切换 Mermaid 主题
- 进入视口后才加载
mermaid并渲染,不影响首屏 - 渲染结果经 DOMPurify 清理,Mermaid 以
securityLevel: 'strict'运行 - 悬停时右上角显示复制源码与全屏查看按钮
文件名
与普通代码块一样,在方括号中写文件名,显示在图表顶部:
ai-chat.mmd
Loading diagram...
```mermaid [ai-chat.mmd]
sequenceDiagram
...
```
图表类型
类图
classDiagram 描述类型与继承关系:
Loading diagram...
状态图
stateDiagram-v2 描述状态流转:
Loading diagram...
饼图
pie 展示占比:
Loading diagram...
甘特图
gantt 展示计划与里程碑:
Loading diagram...
实体关系图
erDiagram 描述数据实体及其关系:
Loading diagram...
自定义样式
在 app/app.config.ts 的 ui.prose.mermaid 中覆盖各插槽的类名:
app/app.config.ts
export default defineAppConfig({
ui: {
prose: {
mermaid: {
slots: {
root: 'my-8 border-primary/40',
diagram: 'bg-default p-6'
}
}
}
}
})
默认主题:
app/app.config.ts
export default defineAppConfig({
ui: {
prose: {
mermaid: {
slots: {
root: 'relative my-5 group border border-muted rounded-md overflow-hidden',
header: 'flex items-center gap-1.5 border-b border-muted bg-default px-4 py-3',
filename: 'text-default text-sm/6',
icon: 'size-4 shrink-0',
toolbar: 'absolute top-2 right-2 flex gap-1 z-10 opacity-0 group-hover:opacity-100 transition-opacity',
diagram: 'p-4 flex justify-center bg-elevated overflow-x-auto',
loading: 'p-4 flex items-center justify-center gap-2 text-sm text-muted',
error: 'p-4 flex items-center justify-center gap-2 text-sm text-error bg-error/10'
},
variants: {
fullscreen: {
true: {
root: 'fixed inset-0 z-50 m-0 rounded-none bg-default flex flex-col',
diagram: 'flex-1 overflow-auto',
toolbar: 'opacity-100'
}
}
}
}
}
}
})
API
Props
| Prop | Default | Type |
|---|---|---|
code | string图表代码 | |
icon | any图标 | |
filename | string文件名 | |
ui | Partial<{ root: string; header: string; filename: string; icon: string; toolbar: string; diagram: string; loading: string; error: string; }> |
Changelog
No recent changes