Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for Mermaid Graphs in documentation #13083

Closed
tedivm opened this issue Feb 25, 2023 · 1 comment
Closed

Support for Mermaid Graphs in documentation #13083

tedivm opened this issue Feb 25, 2023 · 1 comment
Labels
feature request requires triaging maintainers need to do initial inspection of issue

Comments

@tedivm
Copy link

tedivm commented Feb 25, 2023

What's the problem this feature will solve?

Mermaid is a diagramming system that allows diagrams to be defined in Markdown. It uses javascript to convert the text into an SVG. It is supported by Github, so any markdown on Github also supports mermaid.

Describe the solution you'd like

The QuasiQueue project uses Mermaid. The PyPi project just displays it as a codeblock, rather than a graph. It does render on Github. It would be nice if PyPi supported it since it would mean diagrams could be easily embedded in documentation.

Additional context

@tedivm tedivm added feature request requires triaging maintainers need to do initial inspection of issue labels Feb 25, 2023
@di
Copy link
Member

di commented Feb 25, 2023

Duplicate of pypa/readme_renderer#223.

@di di closed this as completed Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request requires triaging maintainers need to do initial inspection of issue
Projects
None yet
Development

No branches or pull requests

2 participants