# lukilabs/beautiful-mermaid

Repository: https://github.com/lukilabs/beautiful-mermaid
Canonical: https://ross.abutalabs.com/products/beautiful-mermaid
Language: TypeScript
License: MIT
License Family: permissive
Last push: 2026-05-06T10:53:19+00:00

## Health v2 (maintenance only)
Score: 65/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 81, release rhythm 72, longevity 15
- inputs: {"age_days": 217, "days_push": 119, "days_rel": 188, "gap_med": 0, "n_releases_24m": 6}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 10976, forks 391 (observed 2026-08-28T04:10:44.933015+00:00)

## What it is
A TypeScript library that renders Mermaid diagram syntax as polished SVG or ASCII/Unicode art, with zero DOM dependencies and synchronous rendering. It supports six diagram types, 15 built-in themes, and Shiki theme compatibility.

## Use cases
- render mermaid diagrams as svg in a web app
- display flowcharts as ascii art in a terminal
- visualize diagrams inside an AI coding assistant chat
- theme mermaid diagrams with a VS Code theme
- render diagrams synchronously in React with useMemo
- generate sequence and ER diagrams without a browser DOM

## When to choose
- you need fast, dependency-light Mermaid rendering in Node, Bun, or the browser
- you want terminal-friendly ASCII output for CLI tools
- you need deep theming control or Shiki/VS Code theme compatibility
- you want synchronous rendering without async flashes in UIs

## When to avoid
- you need diagram types beyond flowchart, state, sequence, class, ER, or XY charts
- you rely on Mermaid's full feature set or interactive features
- you need a pure client-side drop-in replacement for mermaid.js with identical output

## Facets
- artifact type: library
- maturity: active
- function: data-visualization, templating
- domain: developer-tools, data-visualization, documentation
- platform: bun, cli, cross-platform
- tags: mermaid, diagram-rendering, svg, ascii-art, theming, zero-dom-dependencies, typescript, nodejs

## Member repositories
- lukilabs/beautiful-mermaid (main) score 65

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:44.933015+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:17:15.866378+00:00, confidence not recorded.
  - readme: https://github.com/lukilabs/beautiful-mermaid (fetched 2026-08-28T04:10:44.933015+00:00, sha f9848c57f54c)
  - registry_npm: https://registry.npmjs.org/beautiful-mermaid (fetched 2026-08-29T08:16:11.163721+00:00, sha 972265288b11)
- Data as of 2026-08-30T08:39:29.467469+00:00.