用途:当用户要求创建 Mermaid 图、修复 Mermaid 语法错误、图无法渲染或涉及特定图表类型时使用。提供综合语法参考,帮助避免常见错误。
主要能力:支持 Mermaid v11 的流程图、时序图、类图、状态图、ER 图、甘特图、饼图、Git 图等;汇总关键规则,如含特殊字符的文本需用双引号包裹,reserved 词(end、default、style、class、click 等)须使用带引号的标签与安全 ID,注释只用 %%,时序图中分号用 #59;,frontmatter 的 --- 必须位于第一行,linkStyle 中十六进制颜色不可作为最后一个属性,classDiagram 的关系与注释需写在 namespace 块之外,architecture-beta 标签仅支持字母数字下划线等。还列出 v11 新特性:手绘外观、时序图双向箭头、init 配置指令。
使用方式:按对应图表类型编写语法,动手前可在 https://mermaid.live/ 测试;校验项包括特殊字符加引号、避免 reserved 词作节点 ID、嵌套引号改用单引号或 HTML 实体、子图标题含 <br/> 时加引号等。项目内附 references/、examples/ 参考文件与 scripts/validate-mermaid.sh 校验脚本,外部文档见 https://mermaid.js.org/intro/syntax-reference.html。
适用场景:编写或调试各类 Mermaid 图,尤其适合需要规避已知解析错误时。
限制:部分细节与版本相关,如 v11.0 至 11.4 的 --- 无箭头边存在缺陷;maxTextSize 与 maxEdges 为安全设置,无法通过 frontmatter 配置,需在 JavaScript 中用 mermaid.initialize() 设置。具体收费、平台等信息暂未提供。