文档

写给本工作室的 Mermaid 指南

先学本编辑器最常用的图类型。页面短、例子清楚,看完就能在实时预览里试。

  1. 从这里开始:Mermaid 入门弄清 Mermaid 是什么、Vloam Mermaid 编辑器怎么用,并用几分钟画出第一张小图;适合零基础读者,先掌握图类型、预览流程与下一步该读哪篇。
  2. Mermaid 流程图写法入门用方框、判断节点与带标签的箭头,画出从上到下或从左到右的流程图;并说明常用形状、箭头样式、subgraph 分组,以及让标签保持可读的写作建议。
  3. Mermaid 时序图写法入门用参与者、同步与异步箭头以及简短注释,画出谁在什么顺序下发消息;覆盖别名、Note、alt 分支与 loop 循环,并给出控制消息数量的写作建议。
  4. Mermaid 类图写法入门用精简可读的类图画出类型、字段、方法以及它们之间的关系;说明继承、组合、依赖等连线,并给出控制模型规模、命名与方法写法的实用建议,方便边画边改。
  5. Mermaid 状态图写法入门用状态、事件和清晰的起止标记画出对象的生命周期;说明 [*] 起点终点、转移标签,以及何时该嵌套状态、何时该拆成两张扁平图来保持可读与完整。
  6. Mermaid 常见错误排查修好在本编辑器里最常导致预览失败的 Mermaid 写法问题:缺少图类型、括号引号不成对、全角标点、箭头混用,以及把失败图缩到三行再逐步加回的调试步骤。