用途:该技能用于指导在 GitHub Markdown 中创建美观、专业的 Mermaid 图表,确保其在亮色与暗色模式下都能正确渲染。
核心原则:节点使用深色填充搭配浅色描边与白色文字;子图填充设为 none 以适配任意背景;采用圆角形状(stadium、circle、hexagon、cylinder);不使用 Font Awesome 图标,因为 GitHub 不支持 fa:fa-*,会渲染为文本;子图标签需加引号,使用 subgraph Name["Label Text"] 语法;classDef 样式集中定义在顶部。
渲染与自检:写作合法 Mermaid 并非目标,产出可读图表才是。由于自动布局会自行决定节点位置与连线走向,应始终渲染成图预览并迭代。可用命令渲染:npx -y @mermaid-js/mermaid-cli -i diagram.mmd -o diagram.png -b "#0d1117",其中 diagram.mmd 只放 Mermaid 代码本体,不加围栏标记;也可用 mermaid.live 快速预览。以读者视角检查起点终点是否清晰、箭头能否顺畅追踪、相关节点是否相邻、有无孤立节点。若连线缠绕,应调整布局而非仅改颜色:可将主流程排为泳道、删减次要连线、让节点靠近使用方、为孤立组添加单条连接、将横切关注点收敛到单一节点,然后反复渲染直至易读。
样式要点:深色填充配浅色描边的配色示例包括灰、紫、蓝、橙、绿、红、青等组合;子图用 fill:none 加描边与可选虚线;多行标签用 <br/> 而非 \n。常见错误包括使用 Font Awesome 图标、浅色填充配深色文字、子图使用彩色填充、子图标签含空格却未加引号。
适用场景:为 PR 创建架构图、系统流程文档、数据管道可视化、流程图,以及任何 GitHub Markdown 中的图表。GitHub 相关注意:不支持 Font Awesome;换行用 <br/>;含空格的标签需加引号;提交前可用 mermaid.live 本地预览。