公司动态
Mermaid 图表生成工具:3 步完成本地安装与运行,5 分钟画出第一张流程图
Mermaid 图表生成工具3 步完成本地安装与运行5 分钟画出第一张流程图【免费下载链接】mermaidGeneration of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown项目地址: https://gitcode.com/GitHub_Trending/me/mermaid当文档里的图表开始过期流程改了你得打开画图工具挪盒子、重新导出图片等图更新完早忘了当初为什么改。Mermaid 解决的就是这个问题它用接近 Markdown 的文本语法直接生成流程图、序列图、甘特图等图表图文件可以和代码放在同一个仓库里同步演进。下文带你用 3 步完成 Mermaid 图表工具的安装与本地运行并演示 3 张常用图的画法最后附上配置项与排障要点。编辑区、配置区、预览区三栏联动改动即时生效一分钟认识 Mermaid它替你省掉了什么图是文本可进版本控制一张流程图就是几十行文本diff、评审和代码一样方便不再往文档里贴 PNG。零设计基础写graph TD加几个节点和箭头布局自动计算。高频图型全覆盖流程图、序列图、甘特图、类图、状态图等几十个类型一套语法搞定。既能本地跑也能嵌入本地开发服务器用于开发调试也可作为 JS 库嵌入文档站。3 步完成安装并验证运行环境要求Node.js 24仓库.node-version固定为 24.16.0pnpmpackageManager字段固定为 10.30.3Git第 1 步克隆仓库并安装依赖git clone https://gitcode.com/GitHub_Trending/me/mermaid cd mermaid corepack enable pnpm install预期输出依赖逐包安装最后一行显示Done in ...即成功。第 2 步启动开发服务器MERMAID_DEV_PORT9000 pnpm dev预期输出Dev server starting on http://localhost:9000 Listening on http://localhost:9000第 3 步打开页面验证浏览器访问http://localhost:9000根路径是各类图表的演示页清单随便点开一页如 flowchart能看到渲染出的图表即表示安装成功/dev路径是开发编辑界面可写代码、改配置、看预览。先画 3 张高频图流程图、序列图、甘特图画流程图8 行文本描述一个判断流程使用场景把请求处理流程画进设计文档。你会得到一张自动布局的有向图节点形状由括号决定方括号是矩形花括号是判断菱形。graph TD A[接收请求] -- B{鉴权通过?} B --|是| C[写入数据库] B --|否| D[返回401] C -- E[返回结果]首行graph TD中的TD表示自上而下方向改成LR即从左到右。画序列图看清谁先调用谁使用场景复盘一次跨服务调用需要说明时序。你会得到竖向生命线实线箭头表示请求虚线箭头表示返回顺序即时间顺序。sequenceDiagram participant User participant API participant DB User-API: 发送请求 API-DB: 查询数据 DB--API: 返回结果 API--User: 显示响应画甘特图让排期自动避开周末使用场景发布项目排期且任务不能落在周末。你会得到一条时间轴excludes weekends生效后跨周末的任务条自动向后顺延不用手算日期。gantt dateFormat YYYY-MM-DD excludes weekends section 开发 接口设计 :a1, 2026-09-01, 3d个性化调优theme 与 htmlLabels 两个最常用配置以 JS API 方式引入时在渲染前调用一次initialize即可import mermaid from mermaid; mermaid.initialize({ theme: forest, // default / forest / dark / neutral htmlLabels: true });theme整体配色方案影响当前所有图。htmlLabels标签是否按 HTML 渲染大型图表关掉它渲染更快、各浏览器表现更一致。在本地/dev编辑界面里直接改 Config 面板即可看到效果无需重启服务。排障手册4 个高频坑与排查顺序坑 1pnpm install 报网络错误现象pnpm install中途超时或校验失败。原因下载中断缓存里留下损坏的包。解决办法pnpm store prune pnpm install --force坑 2端口被占用现象启动时提示端口已在使用。原因端口被其他进程或同一台机器上的另一个仓库检出占用。解决办法换端口启动MERMAID_DEV_PORT9001 pnpm dev。坑 3图不渲染预览区报语法错误现象写了代码但预览区只显示错误信息。原因语法问题常见如缺冒号、括号类型用错、中文标点混入。解决办法按错误提示定位行号修改拿不准语法时对照 docs/syntax/flowchart.md 逐条核对。坑 4改完 theme 不生效现象initialize传了主题图还是旧样式。原因图表在配置生效前就已经渲染。解决办法确保渲染发生在mermaid.initialize()之后在本地编辑器中则用 Config 面板修改立即重绘。继续深入文档与源码目录清单使用方式入口Live Editor、插件、JS API、依赖引入docs/intro/getting-started.md流程图语法docs/syntax/flowchart.md序列图语法docs/syntax/sequenceDiagram.md甘特图语法含日期排除docs/syntax/gantt.md主题定制docs/config/theming.md核心源码渲染与解析packages/mermaid/src/语法解析器源码packages/parser/src/生态与集成教程docs/ecosystem/要点回顾与下一步✅ 图表即文本与代码同仓库diff 可审 ✅ 3 步完成安装clone →pnpm install→pnpm dev✅ 流程图、序列图、甘特图各几行代码即可上手 ✅theme和htmlLabels是出现频率最高的两个配置 ✅ 卡住时按排障手册的 4 个顺序排查下一步执行MERMAID_DEV_PORT9000 pnpm dev打开/dev页面用 5 分钟把你自己项目的发布流程写成一张graph TD保存为.mmd文件放进仓库。【免费下载链接】mermaidGeneration of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown项目地址: https://gitcode.com/GitHub_Trending/me/mermaid创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考