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

Add mermaid support #10

Closed
clouserw opened this issue Sep 30, 2019 · 2 comments · Fixed by #23
Closed

Add mermaid support #10

clouserw opened this issue Sep 30, 2019 · 2 comments · Fixed by #23

Comments

@clouserw
Copy link
Member

Let's add support for https://mermaidjs.github.io/#/ so we can get easy versioning on our diagrams.

It looks like it's supported as a plugin, but I don't know if the docker container we're using supports plugins. 🤞

@clouserw
Copy link
Member Author

clouserw commented Oct 9, 2019

I looked in to doing this with a Plugin, generating the images ahead of time, and saving them to disk, but I think it would be a lot simpler to just include the JS and have the browser interpret them on the fly. (I don't know if there are limitations to that method).

That method is outlined at https://stackoverflow.com/questions/53883747/how-to-make-github-pages-markdown-support-mermaid-diagram

@lmorchard
Copy link
Contributor

It looks like PR #23 renders Mermaid charts client-side with a third-party JS lib via script tag & CDN - would it at all be feasible to host our own copy of 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

Successfully merging a pull request may close this issue.

2 participants