Add support for Mermaid diagrams#340
Conversation
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
|
@googlebot I signed it! |
|
Here's the link to the doc preview with diagram embedded. |
* Scale diagrams to fit instead of displaying a horizontal scroll bar * Don't display diagram source before rendering * Document diagram level configuration override option
|
This is FANTASTIC. Thanks so much for adding it, it's a great feature. |
|
Feel free to send a mail to docsy-users@googlegroups.com to let the community know about the feature, I think lots of users would like to try it. |
|
Thanks for merging @LisaFC ! I'll have a little update once the next version of Mermaid is released to cleanup the javascript some, and also move it into |
Adding diagrams to documentation is a pretty useful thing; Mermaid really helps as it allows you to generate a diagram from simple code, and keep the code as part of the document, allowing the browser to render it on the fly.
This update allows Mermaid documents to be included as fenced code, in the same way as Gitlab supports, so if you happen to be working in that environment, it should be a similar experience.