Mermaid Live Editor 是一款可以通过简单文本,实时编辑并预览流程图、时序图与甘特图的工具。
可以将编辑完成的内容保存为 SVG 格式,也能轻松分享查看或编辑链接;同时你可以通过 Docker 运行它,或是借助 Node.js 与 pnnpm 在本地部署运行。
使用该工具的优势在于:你无需绘图工具,就能快速创建、协作编辑并更新图表,让文档编写与团队协作的过程变得更快捷、更简便
在技术文档、系统设计和知识表达中,「画图」常常不是最难的部分,难的是保持结构的准确性、可复用性和可维护性。
这正是 Mermaid Live Editor 这个项目存在的意义。
项目定位
mermaid-live-editor 是 Mermaid 官方提供的 在线实时编辑器,用于:
- 编写 Mermaid 文本语法
- 实时渲染结构化图表
- 导出 / 分享 / 校验图表结果
它不是一个「画图软件」,而是一个语法驱动的可视化验证环境(playground)。
核心理念:Text → Structure → Visualization
与传统拖拽式工具不同,Mermaid Live Editor 完全遵循一种工程化思路:
图不是画出来的,而是“描述”出来的。
你只关心三件事:
- 有哪些节点 / 参与者
- 它们之间的关系
- 关系的方向与语义
布局、对齐、线条走向全部交给渲染引擎。
支持的图表能力
Live Editor 覆盖了 Mermaid 的主要图表子语言,包括但不限于:
- Flowchart:流程 / 逻辑 / 系统结构
- Sequence Diagram:接口调用、时序关系
- Class Diagram:类与模块关系
- State Diagram:状态机建模
- ER Diagram:数据结构与实体关系
- Gantt / Timeline:项目计划与时间轴
这使它在技术文档、架构说明、教学示意等场景中非常高效。
为什么要“Live Editor”
从项目角度看,Live Editor 并不是简单的网页工具,而是 Mermaid 生态中的关键基础设施:
- 语法验证器:快速检查 Mermaid 代码是否正确
- 官方参考实现:许多平台的 Mermaid 支持 UI 设计直接参考它
- 教学与演示工具:最直观的学习入口
- 可私有化部署:适合内网 / 文档平台集成
对于写 README、博客、技术方案的人来说,它是最省摩擦成本的图表工具。
与传统画图工具的差异
| 维度 | Mermaid Live Editor | 传统画图工具 |
|---|---|---|
| 输入方式 | 文本描述 | 鼠标拖拽 |
| 关注重点 | 结构与关系 | 外观与布局 |
| 版本管理 | Git 友好 | 几乎不可 diff |
| 自动化 | 极强(可由 AI 生成) | 几乎没有 |
本质区别在于:
Mermaid 是一种“结构语言”,不是设计软件。
AI 时代的价值
在 AI 工作流中,Mermaid Live Editor 的角色非常清晰:
- AI 生成 Mermaid 代码
- Live Editor 即时渲染与校验
- 输出到 Markdown / 博客 / PPT / 文档系统
它是 「AI → 结构化表达 → 可视化」 链路中的最后一环。
结语
mermaid-live-editor 看似简单,但它代表的是一种成熟的工程化表达方式:
用最小的语法成本,换取最大的结构清晰度。
在越来越强调自动化、AI 协作和可维护文档的背景下,这类工具只会变得更重要,而不是被取代。
Github:https://github.com/mermaid-js/mermaid-live-editor
油管:https://youtu.be/Z5CwwHeGgBs