In the 8.8 docs it states that you can embed BPMN diagrams in the readme files:
This sounds great - as I revise my models, the documentation stays up to date. The only catch is that I can’t see how to actually do it and I can’t find any documentation on it (other than the reference above).
I can see that I could export an a diagram as an image, put that somewhere, and then reference that image with a standard ‘!’ command, but I’d have to redo all the exports every time I change a model.
Has anyone managed to get this to work? Apologies if I am missing something obvious…
The documentation mentions embedded BPMN diagrams in READMEs but doesn’t provide specific syntax for this feature. I found the following relevant resources:
The Share → Embed feature generates iframe snippets that always show the latest version of your diagram, but it’s unclear if these work within README Markdown files.
Does this help? If not, can anyone from the community jump in?
Thank’s zee-bot, but that is exactly the problem, the documentation doesn’t give the syntax.
I have tried using an iframe (as generated by the embed function) but this does not work in the renderer used within the Camunda interface. An iframe will, obviously, work in other tools (Obsidian, etc) but that doesn’t help much.
Further, the embedded iframe is far from ideal in a document as the iframe provides a UI to the diagram’s canvas (with the associated UI capabilities), rather than a render of just the diagram.
Short of an extension to the markdown syntax, some kind of link to an SVG of the current version of a diagram (rather than an SVG export) would work as then you could use a ‘!’ command.
Thank you for raising this. I’m sorry for the confusion. We removed this feature for security reasons, because allowing iframes could be risky. We will adjust the documentation.
Hints: Use the Ask AI feature in 