用途:当用户要求创建 Mermaid 图表、修复 Mermaid 语法错误或图表无法渲染时使用,提供覆盖 Mermaid v11 的语法参考,帮助避免常见错误。可在 https://mermaid.live/ 测试图表。
主要能力:支持流程图、时序图、类图、状态图、ER 图、甘特图、饼图、Git 图、思维导图、时间线等;汇总关键规则,如特殊字符需用双引号包裹、保留字(end、default、style、class 等)需用带引号标签、节点 ID 避免以单个 o 或 x 开头、时序图分号用 #59;、注释用 %%、frontmatter 的 --- 必须在第一行、子图标题含 <br/> 需加引号、stroke-dasharray 逗号需转义、思维导图避免 < 字符、类图关系与注释须在 namespace 块外、architecture-beta 标签仅支持 [a-zA-Z0-9_ ] 等。
v11 特性:手绘风格 look: handDrawn、时序图双向箭头 <<->>、init 配置指令;并说明 v11.0-11.4 无箭头边 --- 的缺陷(建议升级 v11.5+ 或改用显式箭头加 linkStyle)、v11 默认按 Markdown 渲染标签的破坏性变更、maxTextSize 与 maxEdges 为安全设置无法通过 frontmatter 配置。
使用方式:按图表类型选择对应语法,遵循校验清单,在 https://mermaid.live/ 验证后再提交。参考文件包括 references/flowchart-complete.md、references/sequence-complete.md、references/class-state-complete.md、references/other-diagrams.md,示例在 examples/ 下,脚本为 scripts/validate-mermaid.sh。
限制:部分复杂泛型、嵌套子图链接、子图方向继承等存在限制;具体平台与收费信息暂未提供。