SuperAPI AI 工具集

beautiful-mermaid-ascii

编程与开发

查看项目

更新于 10-16 03:31

技能介绍

用途

beautiful-mermaid-ascii 用于将 Mermaid 图表转换为终端友好的 ASCII/Unicode 艺术图形。它借助 lukilabs/beautiful-mermaid 这一 JavaScript 库(不是命令行工具)完成渲染,输入来源可以是 .mmd/.mermaid 文件、标准输入,或 Markdown 中的 ```mermaid 围栏代码块。

主要能力

  • 渲染单个 Mermaid 文件。
  • 从标准输入管道渲染。
  • 从 Markdown 中提取第一个 Mermaid 围栏代码块进行渲染。
  • 通过 1 起始的块序号,选择 Markdown 中指定的其他围栏代码块。
  • 提供 --list 选项枚举 Markdown 中的围栏代码块,便于选择。

使用方式

渲染 Mermaid 文件:

skills/beautiful-mermaid-ascii/scripts/mermaid-ascii path/to/diagram.mmd

从标准输入渲染:

cat path/to/diagram.mmd | skills/beautiful-mermaid-ascii/scripts/mermaid-ascii

渲染 Markdown 中第一个 Mermaid 围栏块:

skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --md README.md

选择不同的围栏块(1 起始):

skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --md README.md --block 2

安装方式

脚本 mermaid-ascii 会在需要时自动将 beautiful-mermaid 安装到可写的缓存目录(默认为 $XDG_CACHE_HOME/beautiful-mermaid-ascii,或 /tmp/beautiful-mermaid-ascii),然后运行渲染器。

若希望在 PATH 上获得一个正式的命令,可使用符号链接安装器(默认软链到 ~/.local/bin):

skills/beautiful-mermaid-ascii/scripts/install-mermaid-ascii

也可将该文件夹作为本地/全局 npm 包安装(若 ~/.npm 不可写,请使用可写的 npm 缓存):

# 在仓库根目录执行
NPM_CONFIG_CACHE=/tmp/npm-cache npm install -g --prefix ~/.local ./skills/beautiful-mermaid-ascii

如果当前项目中已安装 beautiful-mermaid,可这样运行:

skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --pkg-dir . path/to/diagram.mmd

故障排查

  • 若因 ~/.npm 或 ~/Library/Caches 权限错误导致安装失败,请使用可写的缓存目录运行:

    skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --cache-dir /tmp/bm-cache ...
    
  • 若输出为空,请检查 Mermaid 文本是否有效,且以图表类型开头(如 flowchart、sequenceDiagram 等)。

  • 若 Markdown 中有多个图表,使用 --list 枚举围栏块并通过 --block 选择。

适用场景

适合需要在纯文本终端环境下查看 Mermaid 图表的用户,例如在无图形界面的服务器、CI 日志、终端工作流中阅读流程图或时序图。

限制

资料未提供关于渲染外观细节、支持的 Mermaid 图表类型完整清单、性能表现或平台兼容性的更多说明。