Feature Request: Support Mermaid (markdown) graph diagrams in .md files

i think this is a important idea for readme, adding my voice here

2 Likes

Being able to embed sequence diagrams in documentation natively would be a killer feature. I see a lot of what seems like edge case features being added, but if this was added and publicized, I imagine a lot of people would use it. I would have used it a long time ago if I knew about it, especially if it was native.

1 Like

I started using gitlabs as documentation is becoming breeze with mermaid support.

2 Likes

please! No diagram rendering means I can’t edit a diagram on your platform and see updates rendered. This severely limits use cases of github for me both personally and professionally. The ability to quickly diagram in documentation is a necessity as a software engineer and system designer, not a luxury.

Hopefully github will do this. I have used the note-taking app Notable and it does it. Notable is md. I am also playing with Obsidian (obsidian.md) which is another newer note-taking app, and it does support it as well.

1 Like

Mermaid is supported in .md by Gitlab. Also more free private repos and a docker registry. Maybe that will focus the priority. :thinking:

1 Like

Hello, can we please get an update on this issue? Mermaid is quickly becoming a necessity for Markdown documentation, and we really need help getting this working in GitHub.

2 Likes

stackedit.io already supports this. Github Flavored Markdown is open source, so you can make a patch.

Add me to the list above that feels that this is an essential feature. I say this as an individual as well as representing my employer - a paying customer.

We need this. Voicing my support as well.

replying to this with my work email to make clear this request is coming from a paying customer

I want this feature too. It’s really need in big project.

Please consider adding this feature!!!

This feature would mean my company would consider switching to github.

We need this feature. Please ~

1 Like