Add mermaid support

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

Maintainer thường phản hồi trong vòng 4 ngày

@FenjuFu đang làm issue này rồi.

Từ ngày 31/10/2026.

  • #861 của @FenjuFu — đang mở

Đá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
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
data-visualization

Hướng nghiên cứu

Bắt đầu bằng việc xác định phần hỗ trợ sơ đồ hiện có của Burr liên quan đến Graphviz và Jupyter, sau đó so sánh cách markdown Mermaid được GitHub render và việc render PNG bằng chương trình sẽ phù hợp với dự án như thế nào. Xác định liệu triển khai ban đầu có nên yêu cầu một npm CLI hay chỉ xuất markdown Mermaid; được xem là hoàn tất khi có một quy trình Mermaid được tài liệu hóa và hoạt động, trong đó dependency và các giới hạn render của nó được nêu rõ.

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

Mô tả

area/visualization good first issue help wanted kind/feature priority/low

Is your feature request related to a problem? Please describe.
Graphviz requires system dependencies. This could prevent users getting a good experience with Burr.

Describe the solution you'd like
Mermaid diagrams I believe require less to get working.

Jupyter support.

Thing to figure out:

  • you still need something to render the mermaid markdown programmatically if someone wants to create a png.
  • github can natively render the mermaid markdown -> so png might not be required (for this initial implementation).
  • I believe npm has a CLI that would be installed to work here - and would require someone to install it for things to work..

Describe alternatives you've considered
N/A

Additional context
Feedback from a user.

Ngôn ngữ chính
Python
Star
2.6k
Fork
212
Merge trung bình
5 ngày 14 giờ
Pull request đã merge (30 ngày)
39

Chuẩn bị môi trường

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 apache/burr

Tất cả issue của apache/burr

Issue tương tự

Thêm issue về Python

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.