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

Investigate mermaid plugin #202

Open
ptbrowne opened this issue Feb 18, 2021 · 0 comments
Open

Investigate mermaid plugin #202

ptbrowne opened this issue Feb 18, 2021 · 0 comments

Comments

@ptbrowne
Copy link
Contributor

Mermaid is useful to create diagrams and schemas. We already
use it on some of our docs but it is a bit tedious to write
the diagram code in the editor, save the image, move the image
to the git repo, and link it. Additionally, if we forget to
update the image, it can be desynced.

This plugin could help with writing and maintaining easily
mermaid diagrams in our docs by using the mermaid javascript
library to render the diagram from source on the client.

See https://github.com/fralau/mkdocs-mermaid2-plugin#general-principle

What do you think ? Is anybody interested in testing it ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant