Should Elixir's embedded Markdown support Mermaid?

Chat / Discussions
, , ,
1

I just found out about GitHub’s support for Mermaid-based diagrams in README files. This might be a nice addition to Elixir:

Include diagrams in your Markdown files with Mermaid

Mermaid is a JavaScript based diagramming and charting tool that takes Markdown-inspired text definitions and creates diagrams dynamically in the browser. Maintained by Knut Sveidqvist, it supports a bunch of different common diagram types for software projects, including flowcharts, UML, Git graphs, user journey diagrams, and even the dreaded Gantt chart.

2

This has been documented a few weeks back:

3 Likes
3

Wow; talk about fast service!

-r

4

Hello @LostKobrakai, I am trying to figure out what is required to make Mermaid in the embedded Markdown work.

Does the ExDoc documentation describe the result of what will be rendered and the embedded markdown simply needs to contain a code snippet like this example from the Supervisor docs starting with

  ```mermaid

?