termaid:在终端和 Python 应用中渲染 Mermaid 图表

8次阅读
没有评论
termaid:在终端和 Python 应用中渲染 Mermaid 图表
获取下载链全程约 1 分钟
  1. 打开微信,搜索「软件教程管家」关注,或长按下方二维码关注
  2. 回复关键词 termaid
  3. 公众号自动回复网盘链接,点击即可保存下载
termaid:在终端和 Python 应用中渲染 Mermaid 图表打开微信扫一扫关注
或搜索【软件教程管家】
官方渠道:GitHub 仓库

termaid 是一个用纯 Python 实现的 Mermaid 图表终端渲染工具,能把 Mermaid 定义直接画成终端里的 Unicode 或 ASCII 图形,不用打开浏览器,也不用依赖外部服务。写文档、看架构图、查 CI 日志时,图表就在终端里出现,对经常泡在终端和 Python 环境里的开发者来说很顺手。

基本信息

项目名称 termaid
实现语言 纯 Python,核心运行不需要额外依赖
运行方式 命令行、Python 导入调用、标准输入、文件读取
支持图表 流程图、时序图、类图、实体关系图、状态图等
可选扩展 Rich(彩色输出)、Textual(TUI 小部件)
适用场景 终端、SSH 会话、CI 日志、Python 应用、Textual 界面
开源地址 GitHub 仓库 fasouto/termaid

版本选择

termaid 的核心是纯 Python 实现,装好就能用;彩色输出和 TUI 小部件属于可选扩展,需要另外安装对应组件。按需求选:

  • 只想在终端看图:装核心版就够了,命令行和 Python API 都能用。
  • 想要彩色输出:再装 Rich 可选组件,输出带颜色区分,图表层次更清楚。
  • 要在 Textual 界面里嵌图表:再装 Textual 可选组件,用它提供的小部件接入自己的 TUI 应用。

三个版本共用同一套核心渲染逻辑,区别只在输出形式和接入方式,选之前先想清楚图表最终出现在哪里。

安装步骤

  1. 准备好 Python 环境,先确认本机 Python 版本能跑项目,README 没有明确列出支持的版本范围,安装前建议到仓库 README 或源码里核对一次。
  2. 安装核心版:
    pip install termaid
  3. 验证安装:
    termaid --help

    能正常输出帮助信息即表示可用。

  4. 需要彩色输出或 Textual 小部件时,按 README 的可选依赖说明另行安装 Rich 或 Textual 组件,核心安装本身不包含这两项功能。

上手步骤

  1. 准备一个 Mermaid 定义文件,例如 diagram.mmd,写一段简单的流程图:
    graph TD
        A[开始] --> B[处理]
        B --> C[结束]
  2. 从文件渲染:
    termaid diagram.mmd
  3. 从标准输入渲染:
    cat diagram.mmd | termaid
  4. 处理 Markdown 文档时,让工具直接读取文档中的 Mermaid 代码块,不用先把图表定义单独抠出来。
  5. 在 Python 程序里调用:按 README 的 API 说明导入调用,把 Mermaid 文本传进去就能在程序输出里直接看到图表。

必改设置

  • 先确认终端宽度:工具会自动压缩间距、按单词边界换行来适配终端宽度。窗口太窄时先拉宽终端再渲染,复杂图不容易被挤变形。
  • 字符集不兼容就切 ASCII 模式:终端字体不支持盒线字符时,画面会乱。先用 ASCII 输出验证,再决定日常用 Unicode 还是 ASCII。
  • 主题按场景选:项目提供 11 个主题,默认主题在浅色终端和深色终端下的观感不同,换一个主题往往比调字体更有效。
  • 输入来源固定下来:文件、标准输入、Markdown 代码块三种入口别混用。脚本里固定一种来源,出问题时排查范围小得多。
  • 彩色输出单独验证:Rich 是可选组件,装了核心版不等于有了彩色输出。装完扩展后单独跑一次彩色渲染,确认生效再写进工作流。

注意事项

  • README 没有给出各类 Mermaid 语法的完整支持矩阵,复杂语法先用实际图表测试,不要默认所有 Mermaid 写法都能渲染。
  • README 没有明确列出支持的 Python 版本,换环境部署前务必先核对运行时兼容性。
  • 彩色输出和 Textual 小部件依赖可选组件,只装核心版时这些功能不可用,部署清单要把可选依赖单独列出来。
  • 终端渲染效果依赖字符宽度和字体表现,同一张图在不同终端里可能有差异,重要场合先在目标终端实测。
  • 它定位是终端文本渲染,不是浏览器交互式图表的替代品,需要交互、缩放、导出矢量图时应另选工具。

适用人群

适合需要在 Python 环境、终端、SSH 会话或 CI 日志里查看 Mermaid 图表的开发者,也适合想在自己的工具里直接调用 Python API 渲染图表的工具作者。经常写技术文档、画架构图,又不想为看一张图反复切浏览器的人,用起来最顺。

同类对比

工具 语言生态 适合场景
termaid Python 终端渲染、Python 程序内调用、CI 日志
mermaid-ascii Go Go 生态下的终端文本渲染
beautiful-mermaid TypeScript 前端与 Node 生态下的渲染

三者的取舍关键在语言生态:如果工作流已经是 Python,termaid 的接入成本最低;如果团队主力是 Go 或 TypeScript,对应生态的工具更顺手。渲染边界则要拿自己的实际图表逐个测试,README 的类型清单不等于完整兼容承诺。

下载

GitHub 下载 termaid

GitHub 国内访问较慢,如打不开可多刷新几次

推广termaid:在终端和 Python 应用中渲染 Mermaid 图表

关注「软件教程管家」

回复软件名即取即下:网盘下载链接 + 提取码,一步直达,不用再跳转。

版权与使用提示

本站资源仅供个人学习交流,请勿用于商业用途。软件与资料版权归原作者所有;如有侵权,请通过公众号「软件教程管家」联系我们,我们将在 24 小时内下架处理。查看免责声明 ›

上次编辑至今:2天 · 内容还比较新鲜

公告

契机库网站正式上线!

了解更多
收藏这款软件我的收藏 →

这款软件怎么样?

平均 暂无评分(0 人评)

取链次数:0

评分与投票来自真实访客,从 0 开始累计;觉得有用就点一下,帮更多人判断这款软件值不值得下。

正文完
 0