[Design] Style Mermaid diagrams
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
Research direction
Start at /design-audit#authored-content and the Mermaid rendering and preview surfaces in packages/editor. Compare native Mermaid theming, beautiful-mermaid, and another maintained approach, then run the listed type, CI, editor test, and E2E commands. Done means an approved audit covering representative and invalid states, with security, accessibility, bundle, performance, and limitation evidence.
Written by the indexing model from the issue text.
Description
Base branch: main
Branch: maggie/style-mermaid-diagrams
Depends on: None
Goal
Research and implement a distinctive, readable Mermaid visual system for Chopin diagrams instead of the current generic neutral rendering.
Context From Planning
- Mermaid diagrams in
/design-audit#authored-contentlook poor and need a dedicated design pass. - Investigate existing styled Mermaid approaches rather than inventing every diagram treatment from scratch.
- Candidate:
beautiful-mermaidoffers token-like two-color theming and React integration: https://github.com/lukilabs/beautiful-mermaid. Mermaid itself supportsbasetheme variables andthemeCSS. Treat these as candidates, not selected dependencies.
Current Behavior
Chopin lazily renders Mermaid with strict security, HTML labels disabled, suppressed Mermaid error SVGs, and the built-in neutral theme. The editor owns source and preview; wide diagrams use authored drawing size inside an overflowable preview so labels remain readable.
Desired Behavior
Define a Chopin diagram theme and presentation shell with clean typography, hierarchy, spacing, connectors, nodes, groups, state colors, overflow, source controls, and parse-error treatment across common software-planning diagrams.
Acceptance Criteria
- A research note compares native Mermaid
basetheme variables/themeCSS,beautiful-mermaid, and at least one other maintained styling approach for quality, diagram coverage, security, bundle cost, and React/editor fit. - The design audit includes representative flowchart, sequence, state, class/entity, and dense/wide diagrams plus invalid and empty source states.
- Diagram colors, type, radii, strokes, and spacing derive from Chopin design tokens where Mermaid permits.
- Labels remain readable, diagrams can be keyboard-scrolled, and narrow layouts preserve the current overflow behavior.
- Strict security, disabled HTML labels/click handlers, lazy loading, parse-error containment, and source ownership remain intact.
- The chosen approach avoids a second editor or writing generated SVG into Lexical's canonical source.
- Maggie approves the audit specimens before production migration.
Verification Commands
bun run typesbun run cibun test packages/editorbun run e2e
Primary Surfaces
/design-audit#authored-content- Mermaid rendering and preview in
packages/editor - Shared Chopin color, typography, radius, and spacing tokens
Expected PR Checks
- Repo required checks
Report Requirements
- Library/theme comparison and dependency decision
- Before/after screenshots for every representative diagram
- Security, accessibility, bundle, and performance evidence
- Unsupported diagram-specific styling limitations
Implementation Notes
- Prefer native theming when it can reach the desired quality; add a dependency only when it materially improves output and remains maintainable.
- Keep arithmetic/layout owned by Mermaid or application code, not model-generated pixel coordinates.
- Preserve generated SVG sanitization/security boundaries and the derived-preview ownership model.
Stop Conditions
- A candidate requires enabling HTML labels, scripts, click handlers, or unsafe rendering.
- The visual direction cannot cover common diagram types consistently without a design decision.
- Dominant language
- TypeScript
- Stars
- 351
- Forks
- 20
- Avg merge
- 14h 7m
- Merged PRs (30d)
- 34
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from githubnext/chopin
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
githubnext/chopin#154 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
githubnext/chopin#149 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
githubnext/chopin#164 ·
-
Difficulty 5/5 Over a week Newbie friendliness 38/100
githubnext/chopin#163 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
githubnext/chopin#162 ·
All issues in githubnext/chopin
Similar issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Crush Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ElementsProject/cln-application#167 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Quantco/pnpm-licenses#17 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100