Back to Details

beautiful-mermaid-ascii

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Beautiful Mermaid ASCII Rendering

美观的Mermaid ASCII渲染

Use 
lukilabs/beautiful-mermaid
(a JS library, not a CLI) to turn Mermaid diagrams into terminal-friendly ASCII/Unicode art.
使用
lukilabs/beautiful-mermaid
（一个JS库，而非CLI工具）将Mermaid图表转换为适合终端显示的ASCII/Unicode艺术图。

Quick start

快速开始

Render a Mermaid file:
bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii path/to/diagram.mmd
Install a clean 
mermaid-ascii
command on your PATH (symlink into 
~/.local/bin
by default):
bash
skills/beautiful-mermaid-ascii/scripts/install-mermaid-ascii
Render from stdin:
bash
cat path/to/diagram.mmd | skills/beautiful-mermaid-ascii/scripts/mermaid-ascii
Render the first Mermaid fenced block from Markdown:
bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --md README.md
Select a different fenced block (1-based):
bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --md README.md --block 2
渲染Mermaid文件：
bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii path/to/diagram.mmd
在PATH中安装干净的
mermaid-ascii
命令（默认软链接到
~/.local/bin
）：
bash
skills/beautiful-mermaid-ascii/scripts/install-mermaid-ascii
从标准输入渲染：
bash
cat path/to/diagram.mmd | skills/beautiful-mermaid-ascii/scripts/mermaid-ascii
渲染Markdown中的第一个Mermaid代码块：
bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --md README.md
选择不同的代码块（从1开始计数）：
bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --md README.md --block 2

Installation approach (how this skill “deals with installing”)

安装方式（本技能的安装处理逻辑）

scripts/mermaid-ascii
auto-installs 
beautiful-mermaid
into a writable cache directory (defaults to 
$XDG_CACHE_HOME/beautiful-mermaid-ascii
, or 
/tmp/beautiful-mermaid-ascii
) when needed, then runs the renderer.
If you want a “real” command on your PATH, prefer the symlink installer:
bash
skills/beautiful-mermaid-ascii/scripts/install-mermaid-ascii
You can also install this folder as a local/global npm package (use a writable npm cache if your 
~/.npm
is not writable):
bash
undefined
scripts/mermaid-ascii
会在需要时自动将
beautiful-mermaid
安装到可写的缓存目录（默认是
$XDG_CACHE_HOME/beautiful-mermaid-ascii
，或
/tmp/beautiful-mermaid-ascii
），然后运行渲染器。
如果你希望在PATH中有一个“正式”的命令，推荐使用软链接安装脚本：
bash
skills/beautiful-mermaid-ascii/scripts/install-mermaid-ascii
你也可以将此文件夹作为本地/全局npm包安装（如果你的
~/.npm
不可写，请使用可写的npm缓存）：
bash
undefined

from the repo root

从仓库根目录执行

NPM_CONFIG_CACHE=/tmp/npm-cache npm install -g --prefix ~/.local ./skills/beautiful-mermaid-ascii

If you already have `beautiful-mermaid` installed in the current project, run with:

```bash
skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --pkg-dir . path/to/diagram.mmd
NPM_CONFIG_CACHE=/tmp/npm-cache npm install -g --prefix ~/.local ./skills/beautiful-mermaid-ascii

如果你已在当前项目中安装了`beautiful-mermaid`，可以通过以下命令运行：

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

Troubleshooting

故障排除

  • If installs fail due to permission errors in 
    ~/.npm
    or 
    ~/Library/Caches
    , run with a writable cache directory: 
    • skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --cache-dir /tmp/bm-cache ...
  • If output is empty, verify the Mermaid text is valid and starts with a diagram type (
    flowchart
    , 
    sequenceDiagram
    , etc.).
  • For multiple diagrams in Markdown, use 
    --list
    to enumerate fenced blocks and choose one with 
    --block
    .
  • 如果因
    ~/.npm
    或
    ~/Library/Caches
    的权限错误导致安装失败，请使用可写的缓存目录运行： 
    • skills/beautiful-mermaid-ascii/scripts/mermaid-ascii --cache-dir /tmp/bm-cache ...
  • 如果输出为空，请验证Mermaid文本是否有效，且以图表类型开头（如
    flowchart
    、
    sequenceDiagram
    等）。
  • 对于Markdown中的多个图表，使用
    --list
    枚举所有代码块，然后用
    --block
    选择其中一个。

Bundled resources

捆绑资源

  • skills/beautiful-mermaid-ascii/scripts/mermaid-ascii
    : Shell wrapper that ensures dependencies are available, then renders.
  • skills/beautiful-mermaid-ascii/scripts/mermaid-ascii.mjs
    : Node CLI that extracts Mermaid (raw or from Markdown fences) and calls 
    renderMermaidAscii
    .
  • skills/beautiful-mermaid-ascii/references/notes.md
    : Small notes about Mermaid inputs and common patterns.
  • 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输入和常见模式的小型说明文档。