mcpField
B
beautiful-mermaid-ascii

beautiful-mermaid-ascii

github.com/ratacat文档处理5846 次安装37 周前更新
代码仓库

关于 beautiful-mermaid-ascii

这是一个将 Mermaid 图表渲染为终端 ASCII/Unicode 艺术的技能,适合需要在命令行查看图表的用户。它可读取原始 Mermaid 输入,也能从 Markdown 中提取指定代码块。

主要功能

  1. 01渲染 Mermaid 为 ASCII/Unicode
  2. 02读取文件或标准输入
  3. 03从 Markdown 提取图表代码块
  4. 04列出并选择代码块
  5. 05按需安装渲染依赖

适用场景

  1. 01在终端查看 Mermaid 图表
  2. 02从 README 提取图表并渲染
  3. 03在无图形界面的环境检查流程图

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ratacat/claude-skills --skill beautiful-mermaid-ascii

安装后在 Claude Code 中输入/beautiful-mermaid-ascii确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

package.json
references/
mermaid-cheatsheet.md
mermaid-syntax-reference.md
notes.md
scripts/
install-mermaid-ascii
mermaid-ascii
mermaid-ascii.mjs

详细介绍

美观的 Mermaid ASCII 渲染

使用 lukilabs/beautiful-mermaid(一个 JS 库,而非 CLI)将 Mermaid 图表转换为适合终端显示的 ASCII/Unicode 艺术图。

快速开始

渲染 Mermaid 文件:

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

在 PATH 中安装一个简洁的 mermaid-ascii 命令(默认会创建指向 ~/.local/bin 的符号链接):

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

从标准输入进行渲染:

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

安装方式(此技能“如何处理安装”)

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

如果你希望在 PATH 中使用一个“真正的”命令,建议使用符号链接安装程序:

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

你也可以将此文件夹安装为本地/全局 npm 包(如果 ~/.npm 不可写,请使用可写的 npm 缓存):

# from the repo root
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 选择一个。

附带资源

  • skills/beautiful-mermaid-ascii/scripts/mermaid-ascii:Shell 包装脚本,用于确保依赖项可用,然后进行渲染。
  • skills/beautiful-mermaid-ascii/scripts/mermaid-ascii.mjs:Node CLI,用于提取 Mermaid 内容(原始文本或 Markdown 围栏代码块),并调用 renderMermaidAscii。
  • skills/beautiful-mermaid-ascii/references/notes.md:关于 Mermaid 输入和常见模式的简要说明。

评论

支持 Markdown