mgaitan/sphinxcontrib-mermaid

🎨 Nhúng Mermaid vào Sphinx một cách trực tiếp

Một extension nhỏ nhưng hữu ích, biến Mermaid thành phần tử hoạt họa trong tài liệu Sphinx.

sphinxcontrib-mermaid là một extension cho Sphinx, cho phép nhúng các sơ đồ Mermaid như flowchart, sequence diagram, Gantt chart… trực tiếp vào tài liệu viết bằng reStructuredText hoặc Markdown. Tạo bởi Marco Gaitán, dự án đang tìm kiếm người duy trì mới.

✨ Điểm nổi bật

• Hỗ trợ đa dạng sơ đồ Mermaid: flowchart, sequence, Gantt, v.v.
• Directive mermaid: nhúng mã Mermaid trực tiếp hoặc từ file .mmd.
• Render đa dạng: HTML dùng JS, builders khác dùng mermaid-cli xuất PNG/SVG.
• Directive autoclasstree: tự động sinh sơ đồ kế thừa lớp.
• Tùy chỉnh chi tiết: name, alt, align, caption, zoom, fullscreen, config, title.
• Cấu hình linh hoạt: mermaid_output_format, mermaid_cmd, mermaid_cmd_shell.

💡 Vì sao đáng chú ý

Thay vì phải xuất sơ đồ riêng rồi chèn ảnh, sphinxcontrib-mermaid cho phép viết trực tiếp mã Mermaid trong tài liệu, tích hợp liền mạch với workflow Sphinx. Đặc biệt hữu ích cho tài liệu kỹ thuật cần trình bày logic phức tạp.

#Sphinx #Mermaid #Diagrams #OpenSource #TiniX