Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Design] Style Mermaid diagrams

Đang mở
#165 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
design, frontend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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-content look poor and need a dedicated design pass.
  • Investigate existing styled Mermaid approaches rather than inventing every diagram treatment from scratch.
  • Candidate: beautiful-mermaid offers token-like two-color theming and React integration: https://github.com/lukilabs/beautiful-mermaid. Mermaid itself supports base theme variables and themeCSS. 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 base theme 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 types
  • bun run ci
  • bun test packages/editor
  • bun 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.
Ngôn ngữ chính
TypeScript
Star
351
Fork
20
Merge trung bình
14 giờ 7 phút
Pull request đã merge (30 ngày)
34

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của githubnext/chopin

Tất cả issue của githubnext/chopin

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.