iotaledger / documentation-platform

Legacy documentation platform
Apache License 2.0
52 stars 13 forks source link

Add support for mermaid plugin #250

Closed JakeSCahill closed 3 years ago

JakeSCahill commented 4 years ago

Currently, we create diagrams and export them as .png files to use in the docs.

The problem with this approach is that when we come to translate the content, recreating these images will be time-consuming. We'll have to extract the text, translate it, and recreate the image.

The mermaid plugin takes markdown and converts it into diagrams, saving us this extra work in the long-run.

https://github.com/mermaid-js/mermaid https://mermaid-js.github.io/mermaid/#/