Ask a Question
Back to All

Support for Mermaid or other Markdown-generated images?

Hey Readme team,

Sometimes (more like all the time) when I'm documenting, I'd love to illustrate data flows or ideas with a diagram. Now I could draw something up and insert a picture, but this adds load times, doesn't play nice with dark themes and generally adds bloat to my writing flow.

Now I think Github does a great job at supporting Mermaid - a way to describe a diagram in markdown that then gets rendered in the document. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams

I think this would be a nice addition to readme, too. What do you think?