Add rendering of Mermaid diagrams

[piranna]

Mermaid allow the rendering of diagrams from markdown-like text snippets. Code-highlighting could be reused to render them when setting mermaid as the languaje. This is related to #334

[gjtorikian]

I wonder if this is something @github/render would be interested in picking up? The project does look interesting.

@piranna Can you give us a sense of how this is currently used across GitHub? Is there an extension for the file format, for example?

[piranna]

@piranna Can you give us a sense of how this is currently used across GitHub? Is there an extension for the file format, for example?

I've not seen anybody using it on GitHub, maybe because it's not an available functionality, nor know of any browser extensión.

On the other hand, I've seen a webservice that generate PNG images from Mermaid snippets that can be inserted on Markdown files (sorry, I can't find the link now) and a quick search has shown me other use cases, like a plugin for gitbook, a plugin for LightTable and a plugin for Jekyll (maybe you would be more interested in that last one).

+1

fyi, Google has implemented SVG for Gantt Charts in the Google Charts API ...

• https://developers.google.com/chart/interactive/docs/gallery/ganttchart

[alanjames1987]

+1

[trusch]

+1

[kivikakk]

This isn't quite a markup-related issue so I'm closing the issue, but we're definitely still thinking about things like this. If you have other feature requests, please reach out to the support team.

[wmertens]

Note, in v1.15 of VSCode they enabled extensions for the markdown previewer, and there is https://github.com/mjbvz/vscode-markdown-mermaid which renders the images inline.

[wmertens]

@kivikakk So the request here was to add support for Mermaid, which would be two-fold:

• Support rendering .mermaid files
• Support rendering ```mermaid code blocks as Mermaid. I am not sure if this is possible? Are code blocks always passed to linguist?

It seems to me that this is indeed related to markup?

[kivikakk]

It seems to me that this is indeed related to markup?

This repo is for things relating specifically to the github-markup gem; if an issue cannot be resolved by some change to code in this repo, then it doesn't belong here (and instead belongs with the support team). I hope that helps clarify!

[themightychris]

Did an issue over get created in the appropriate place for this? It would be an amazing addition to github

[wmertens]

@themightychris I think the appropriate repo is https://github.com/gjtorikian/commonmarker, not sure, no issue created yet.

[kivikakk]

The correct destination is the support team! They handle feature requests for github.com.