apache / apache/burr

Add mermaid support

Open
#414 8 comments 0 reactions 0 assignees View on GitHub
area/visualization good first issue help wanted kind/feature priority/low
Dominant language
Python
Stars
2.5k
Forks
195
Avg merge
6d 10h
Merged PRs (30d)
17

Description

**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](https://pypi.org/project/python-mermaid/) diagrams I believe require less to get working.

[Jupyter support](https://blog.jupyter.org/jupyterlab-4-1-and-notebook-7-1-are-here-20bfc3c10217).

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.