Markdown / docs embedding

Markdown is a simple text format used for documentation, wikis and README files. Markdown embedding means a diagram written in a text syntax can sit inside such a file and be drawn automatically when the page is displayed. Mermaid, for example, lets you put a diagram inside a fenced block in a Markdown file.

When diagrams live as pictures, they must be exported, uploaded and replaced every time something changes, and people forget. When the diagram is part of the document text, one edit updates the page. It stays next to the text it explains, and the history of changes covers both.

It helps teams who keep documentation in a repository or a documentation platform. It is of little use if your documents live in a word processor or slide deck that does not understand the syntax.

• Which platforms you already use render the diagrams natively, and which need a plugin?
• Which version of the syntax do they support?
• What happens in a viewer that does not support it: does the reader see the raw text?
• Can you also export a fixed image for slides or PDFs?