用途:beautiful-mermaid 用于把 Mermaid 代码块(mermaid ... )渲染成美观的 SVG 或 ASCII/Unicode 图形,适合用户要求“渲染”或“可视化”图表、需要终端输出或主题化图形的场景。
主要能力:支持流程图(graph TD/LR/BT/RL)、状态图(stateDiagram-v2)、时序图(sequenceDiagram)、类图(classDiagram)、ER 图(erDiagram)。提供 SVG 与 ASCII 两种输出;内置 15 种主题(如 zinc-light、tokyo-night、catppuccin-mocha、nord、dracula、github-dark、solarized-dark、one-dark 等),支持仅用 bg/fg 两色的 Mono 模式、含 line/accent/muted/surface/border 的增强主题,并可通过 fromShikiTheme 从 Shiki 主题提取配色。
使用方式:安装命令为 npm install beautiful-mermaid,或 bun add beautiful-mermaid,或 pnpm add beautiful-mermaid。SVG 输出用 renderMermaid(text, options?),返回 Promise;ASCII 输出用 renderMermaidAscii(text, options?),同步返回字符串。ASCII 选项含 useAscii、paddingX、paddingY、boxBorderPadding;SVG 选项含 bg、fg、line、accent、muted、surface、border、font、transparent。
适用场景:在 Telegram 等渠道把 Mermaid 渲染为 SVG 图片发送,或在终端/CLI 中打印 ASCII 图形。
限制:资料未提供具体版本兼容性、浏览器支持范围、错误处理方式及许可证信息;性能数据(100+ 图 <500ms)来自资料自述,未提供测试环境。