尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

mermaid-ascii完全入门:安装、CLI命令与三大图表类型一次讲清

mermaid-ascii完全入门:安装、CLI命令与三大图表类型一次讲清 mermaid-ascii完全入门安装、CLI命令与三大图表类型一次讲清【免费下载链接】mermaid-asciiRender Mermaid graphs inside your terminal项目地址: https://gitcode.com/GitHub_Trending/me/mermaid-asciimermaid-ascii是一款免费的开源命令行工具能把 Mermaid 图表语法直接渲染成终端里的 ASCII 字符图支持流程图、时序图、ER 图三大图表类型还可以启动 Web 界面交互式画图。本文带新手从零完成安装、掌握常用 CLI 命令并一次看懂三种图表的渲染效果。mermaid-ascii 是什么平时我们用 Mermaid 写图表渲染出来往往是图片要查看得打开浏览器。mermaid-ascii 的思路完全不同它把 Mermaid 代码解析后用┌─┐ │ └►这类字符直接画在你的终端里纯文本、不依赖图片、方便复制进文档和聊天记录。它的核心能力 单二进制文件跨平台运行无需安装浏览器或 Node 环境️ 支持流程图Flowchart/Graph、时序图Sequence、实体关系图ER 内置web子命令启动本地 Web 编辑器实时预览 支持终端彩色输出classDef语法渲染逻辑位于 cmd/diagram.go参数定义在 cmd/root.go。一键安装步骤mermaid-ascii 提供了四种安装方式新手推荐前两种。方式一下载预编译二进制推荐从项目 Releases 页面下载对应平台的压缩包解压后即可使用tar xvzf mermaid-ascii_*.tar.gz ./mermaid-ascii --help方式二源码构建如果你已有 Go 环境两步搞定git clone https://gitcode.com/GitHub_Trending/me/mermaid-ascii cd mermaid-ascii go build构建入口见 main.go也可用 Makefile 中的make命令生成二进制和 shell 补全脚本。方式三Nix / DockerNix克隆仓库后执行nix build产物在./result/bin/mermaid-ascii配置见 flake.nixDockerdocker build -t mermaid-ascii .后直接运行构建文件为 Dockerfile快速上手渲染第一张流程图在文件test.mermaid中写入graph LR A -- B C B -- C D D -- C执行渲染命令mermaid-ascii --file test.mermaid终端会立刻输出带箭头和方框的 ASCII 流程图。也可以用管道从标准输入读取cat test.mermaid | mermaid-ascii想调整疏密两个参数最常用-x 8增大节点横向间距-p 3加大方框内边距图会变得更透气。CLI 命令与参数速查这是新手最常问的「最快配置方法」清单全部参数在 cmd/root.go 中定义参数缩写默认值作用--file-f空读 stdin指定 Mermaid 文件-f -表示从标准输入读取--paddingX-x5节点之间的横向间距--paddingY-y5节点之间的纵向间距--borderPadding-p1方框内文字与边框的留白--ascii-a关强制纯 ASCII 字符输出---风格--coords-c关在图上叠加坐标调试布局用--verbose-v关输出详细日志两个子命令mermaid-ascii help查看任意命令帮助mermaid-ascii completion shell生成 bash / zsh / fish 自动补全脚本三大图表类型一次讲清1️⃣ 流程图 / Graph分支逻辑一目了然以graph LR从左到右或graph TD从上到下开头核心就是节点加箭头graph LR A --|开始| B B -- C亮点功能带标签的箭头--|label|、同一行多箭头A -- B -- C、A B批量连接多种箭头样式-.-虚线、粗线、--o圆头、--x叉头用classDef定义颜色终端支持时会显示彩色流程图2️⃣ 时序图 / Sequence接口调用链的利器时序图用来表达参与者之间的消息流非常适合调试接口调用sequenceDiagram Alice-Bob: Hello Bob--Alice: Hi渲染效果是竖线生命线加横向箭头消息标签显示在箭头上方。已支持的功能相当全面实线 / 虚线 / 交叉 / 双向箭头以及自消息A-A: thinkparticipant A as Alice别名声明loop、opt、alt/else、par/and、break、rect等组合片段可嵌套autonumber自动编号、Note over A便签、Unicode 与 emoji解析与绘制分别在 pkg/sequence/parser.go 和 pkg/sequence/renderer.go。3️⃣ ER 图数据库关系用字符画表达ER 图会把实体渲染成带属性列的表格关系用「鸦爪」符号连接erDiagram CUSTOMER ||--o{ ORDER : places支持所有鸦爪基数符号||、|o、}o、}|、数字与文字基数形式识别关系画实线、非识别关系画虚线每个关系标签独占一条走线永不互相碰撞。实体还能声明字段类型、主外键PK/FK和注释。相关实现见 pkg/er/parser.go 与 pkg/er/layout.go。进阶技巧Web 界面与配色不想敲命令一条命令启动浏览器交互编辑器mermaid-ascii web然后访问http://localhost:3001。左侧粘贴 Mermaid 代码右侧实时预览 ASCII 结果还能拖动滑块调整 xPadding / yPadding、切换扩展字符开关、一键复制输出。页面逻辑在 templates/index.tmpl服务实现见 cmd/web.go。想让节点显示颜色加上classDef即可例如classDef hot color:#ff0000 A:::hot -- B前提是终端支持 ANSI 颜色。渲染配置的统一入口是 pkg/diagram/config.go。常见问题FAQQ输出的字符图在别的终端里错位了用--ascii强制纯 ASCII 模式只使用 - | 等基础字符。Q图太挤 / 太散怎么办组合调节-x横向间距、-y纵向间距、-p框内留白三个参数即可。Q支持哪些方向流程图支持graph LR从左到右和graph TD从上到下时序图与 ER 图按各自语义自动布局。Qsubgraph、非矩形节点支持吗流程图目前仅矩形节点subgraph、斜向箭头、激活框等已在项目 TODO 清单中关注 README.md 的 Supported Diagram Types 章节即可了解最新支持状态。写在最后mermaid-ascii 把「Mermaid 代码」到「终端字符画」的路径压缩到了一条命令。无论是写文档、排查接口时序还是快速给同事演示数据库结构它都能在纯文本环境里派上用场。按本文步骤装好之后先试graph LR再依次体验时序图和 ER 图十分钟就能上手全部三大类型 【免费下载链接】mermaid-asciiRender Mermaid graphs inside your terminal项目地址: https://gitcode.com/GitHub_Trending/me/mermaid-ascii创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表