当前位置: 首页 > news >正文

Mermaid 图表实操指南:如何用代码 3 分钟画出流程图与架构图

Mermaid 图表实操指南:如何用代码 3 分钟画出流程图与架构图

【免费下载链接】mermaidGeneration of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown项目地址: https://gitcode.com/GitHub_Trending/me/mermaid

Mermaid 是一款把文本渲染成图表的开源工具:Mermaid 图表——流程图、时序图、甘特图,都用几行纯文本画出来,可以直接写进 Markdown 文档,天然支持版本管理与评审。

你的项目文档里的图,是怎么画的?

很多人的习惯是:画图工具里摆一摆,截图,粘进文档。问题在于截图会过期——接口改了,文档里的流程图还停在旧版本;评审时没人能对着一张图做 diff,更说不清图和代码是否还对得上。

排项目进度时痛点更具体:把排期导出成图片后,改一个任务的时长或依赖,整张图都得重画。

Mermaid 的思路是把「画」变成「写」:图以文本形式和代码放在同一个仓库里,改文本,图跟着变。上面这张甘特图,就是几行文本渲染出来的。

3 分钟画出第一张 Mermaid 流程图

一个最小的流程图只需要这 5 行:

graph TD A[开始写文档] --> B{图还准确?} B -->|是| C[直接提交] B -->|否| D[随代码更新图] D --> C

graph TD声明从上到下的布局;A[...]是矩形节点,B{...}是判断节点;-->|标签|是带文字标签的连线。生成效果是一张决策流程图,两个分支最后汇回同一个终点。

这套 Mermaid 流程图语法是基础,学会之后,剩下的只是换节点形状和连线样式。

Mermaid 图表还能画哪些类型?

按 语法参考 目录整理,目前覆盖 30 多种图,按用途可以归为四类:

用途典型图型适合场景
流程与叙事流程图、block 图、timeline、用户旅程文档撰写、会议演示
系统设计时序图、类图、ER 图、C4、架构图、状态图接口设计、数据库建模、系统拆分
项目与协作甘特图、Git 图、看板、需求图排期管理、版本追溯、需求跟踪
数据与分析饼图、XY 图、雷达图、桑基图、象限图、韦恩图、思维导图数据展示、方案对比

此外还有铁路图(railroad)、报文图(packet)、Wardley 地图等更专门的图型,需要哪类就去文档目录里按名字找。

如何用 Mermaid 在线编辑器导出 PNG 与 SVG

不装本地环境也能玩:打开官方在线编辑器 mermaid.live,左侧是代码区,右侧是实时预览,旁边还有配置面板可以切换主题、调整布局参数,边输入边同步。

图定稿后,在编辑器的操作区你可以:

  • 下载为 PNG 或 SVG;SVG 是矢量格式,任意缩放不糊,Mermaid 导出 SVG 更适合印刷和嵌入场景
  • 把渲染好的图片直接复制进剪贴板,贴进幻灯片或聊天窗口
  • 复制 Markdown 源码,粘到任何支持渲染的文档里

把 Mermaid 图表接进项目工作流

用熟之后,三个位置最值得放:

README 与文档:图直接写在 README.md 里,支持 Markdown 渲染的平台会自动画出来,不再需要截图。

CI/CD:在流水线里装@mermaid-js/mermaid-cli,用npx @mermaid-js/mermaid-cli.mmd文件批量转成 PNG/SVG,每次合并自动归档一份架构图快照。

Issue 与 PR:正文里贴一段 mermaid 代码块,把「现状 → 目标」画清楚,评审的人可以对着图看 diff。

视觉风格上,Mermaid 内置 default、dark、forest、neutral 等主题,还可以用%%{init}%%指令覆盖主题变量,让全仓库文档风格统一:

%%{init: {'theme':'forest'}}%% graph TD A[任务甲] --> B[任务乙]

更细的配置项可以查 配置文档。

上手清单 🚀

  • 选一条入口:在线编辑器快速出图、npm install mermaid集成进站点,或用命令行工具批量导出
  • 通读一遍 快速入门,亲手跑一次流程图语法
  • 画第一张图:挑文档里一张过期的静态截图,手工写一个 5 行版本
  • 统一主题:用 init 指令设定一次,全仓库生效
  • 接入流程:先在 README 放一张,再让 CI 自动生成

Mermaid 图表的本质,是把「画图」变成「写代码」——写完、预览、提交,三件事。更多图型语法与配置细节,可以翻 语法参考 和官方文档目录 docs/;编辑器插件与第三方集成则收录在社区生态中,新图型还在持续增加。

【免费下载链接】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),仅供参考

http://www.cnnetsun.cn/news/4288746.html

相关文章:

  • Godot 多存档槽存档系统:4 个动作 + 自动备份的完整实现
  • 多智能体框架的选型方法
  • 如何让 AI 设计摆脱“模板脸“:Taste-Skill 色彩规则快速上手指南
  • AI Agent如何重构BPO客服:从聊天机器人到业务自动化节点
  • Dify 5 分钟跑通:4 条命令部署你的第一个 LLM 应用平台
  • Hoppscotch 实时 API 测试指南:WebSocket 与 SSE 连接、日志与排错速查
  • RTC初始化死等问题:LSE晶振起振失败导致系统启动卡死的根因与解决方案
  • STM32WB双核MCU通过IPCC实现FUS固件升级实战
  • 英文Thesis被Turnitin判定大量AI生成:BunnyScholar长篇英文改写实测
  • Gaussian Splatting 实时渲染原理与游戏场景重建实践
  • 英文论文用Turnitin还是GPTZero检测AI率:结果差异与自查方法
  • 2026年写论文的AI论文平台哪个好?千笔AIVS知学术:7大主流平台真实体验对比与选择清单
  • Python房价预测实战:从线性回归到决策树的完整建模与调优指南
  • HPT5K0系列扩展解析:5kW高压电源模块选型与集成要点
  • QPSK仿真链路设计:相位一致性、符号同步与噪声建模
  • FPGA频率仿真与验证:从Quartus约束到AX301开发板实战
  • ParallelClusterMaker:基于AWS ParallelCluster的HPC集群CLI管理实战
  • 边缘辅助农业传感器数据集
  • MarkItDown 实操指南:把 Office 文档转成 Markdown 只要一分钟
  • Storybook 快速上手:3 步把 UI 组件变成可演示、可测试的故事
  • Ventoy 启动盘安装与排错指南:32MB 引导区,镜像长期复用
  • 开源心电异常检测系统:从信号处理到Web可视化完整实现解析
  • C++模板编程:从泛型思维到实战应用,掌握编译期代码生成利器
  • YOLOv8+PyTorch花卉识别实战:从数据集训练到API部署
  • K-means与DBSCAN聚类算法实战:从原理到SPSS应用全解析
  • 大模型内容创作质量提示的方法
  • Spring AOP @Pointcut execution表达式全解析:从语法到实战避坑指南
  • 给AI助手加个收件箱:FastAPI与SQLAlchemy异步任务处理实践
  • oMLX 模型自动发现全解:一个服务器同时加载 LLM、VLM、Embedding 与 Reranker
  • Bun 私有包管理上手:一份 bunfig.toml 配好私有源,安装不再 401