Skip to content

业务图目录

本目录存放业务文档的Mermaid 图源.mmd)。VitePress 站点通过 <MermaidDiagram /> 直渲,无需在正文嵌入 PNG。

类型扩展名说明
图源(主交付).mmd唯一维护源;改后 VitePress 热更新可见
导出(可选).png仅用于 PDF/飞书/截图;pnpm docs:business:diagrams 生成

编辑与预览

  1. 修改 *.mmd
  2. 运行 pnpm docs:business,在浏览器查看对应 flow 页面
  3. 宽图可横向滚动;点击图表下方 「放大浏览」 全屏缩放/平移

可选:导出 PNG

bash
pnpm docs:business:diagrams
# 或
bash docs/business/diagrams/render.sh

环境变量:MMDC_SCALE(默认 2)、MMDC_VERSION(默认 11.4.2)。

Mermaid 语法注意

  • 节点含 { } | / 时用双引号:A["GET /jobs/id"]
  • sequence 的 Note/消息避免分号 ;(会截断)
  • 渲染失败时在 VitePress 页面会显示错误信息,修 .mmd 后刷新即可

以 apps/api 代码为准 · 生成规范见 .cursor/skills/liquia-business-docs