SuperAPI AI 工具集

mermaid-syntax

通用与其它

查看项目

更新于 10-16 00:23

技能介绍

用途:作为 Mermaid 图表语法的权威参考,帮助生成和编写 Mermaid 图表定义,覆盖图表类型、语法模式、示例与平台集成指引。

主要能力:Mermaid 是基于 JavaScript 的图表工具,可将类 Markdown 的文本定义直接渲染为浏览器中的 SVG,并被 GitHub、GitLab、Azure DevOps、Obsidian、Notion 原生支持。其优势包括零配置(浏览器渲染)、原生 Markdown 集成(图表随定义自动同步)、语法比 PlantUML 简单、无外部依赖。

支持的图表类型与关键字:流程图(flowchart 或 graph,适合流程、决策树、工作流)、时序图(sequenceDiagram,适合 API 调用、请求/响应流)、类图(classDiagram,适合 OOP 结构与继承关系)、状态图(stateDiagram-v2,适合状态机与生命周期)、ER 图(erDiagram,适合数据库模式与实体关系)、甘特图(gantt,适合项目时间线)、饼图(pie,适合分布与占比)、Git 图(gitGraph,适合分支策略与提交历史)、C4 上下文(C4Context,系统架构,实验性)、时间线(timeline,时间顺序事件)。

使用方式:在 Markdown 中用带 mermaid 的围栏代码块嵌入图表。

flowchart TD
    A[Start] --> B[End]

平台支持:GitHub 在 README、issue、PR、wiki 中原生渲染;GitLab 在 Markdown 文件中原生渲染;Azure DevOps 在 wiki 和仓库中原生渲染;Obsidian 需核心插件;VS Code 需 Markdown Preview Mermaid Support 扩展。

限制:自定义能力不如 PlantUML;C4 支持为实验性;不支持 MindMap 或 JSON 可视化。详细语法与完整示例见参考文件(flowchart.md、sequence.md、class.md、state-er.md、special-diagrams.md),按创建对应图表类型加载。资料未提供收费标准与价格信息。