Rendering plantuml / mermaid in markdowns included with !docs

[gparmeggiani]

Question

I'm trying to render a plantuml diagram in a markdown file included with !docs, however it doesn't render and I simply see the contents of the plantuml script.

Is this a supported feature?

Here's the example I'm trying to render:

@startuml 

Alice -> Bob: Hello!
Bob -> Alice: Hi!
		
@enduml

[simonbrowndotje]

You have a couple of options:

1. Image views.
2. You can write a DSL plugin to pre-process the PlantUML in your Markdown files ... see https://github.com/structurizr/examples/tree/main/dsl/plantuml-and-mermaid for an example.

[gparmeggiani]

thanks for the reply.

The plugin option achieves exactly what I need, as I can zoom-in from a component to the code where I can describe various aspects of the component with text and multiple plantuml diagrams.

Can the same be achieved with a script instead of a plugin? or could the plantuml / mermaid support be integrated? I'm asking because I'm thinking on how to distribute the plugin without committing to the repo the .jar file

[DaveSlinn]

I know this discussion is in the Lite repo, and it's deprecated in favour of the Structurizr vNext, but I'm still a little unclear on how to enable a Mermaid plugin. I've read the docs, but it sounds like I need to create my own plugin that implements StructurizrDslPlugin, but I see code in the primary repo that does this: Mermaid.java. I've added !plugin com.structurizr.dsl.plugin.documentation.Mermaid.jar to my workspace, but I get an error that it can't be found. Do I need to create my own copy of this jar file, or does it already exist? I am not a Java developer, so I don't have the experience to be making .jar files.

[simonbrowndotje]

The PlantUML and Mermaid plugins are not included in Lite. It's certainly possible to extract them from the vNext repo, compile, and install them into Lite, but I'd recommend just using the new tooling.

[DaveSlinn]

I've switched to the vNext docker image, but my mermaid scripts are not rendering - just showing the diagram text.

Do I have to add a plugin reference in my DSL to enable?

[DaveSlinn]

I thought I was making headway but am still not getting mermaid to render as an image. Here is my workspace:

I've confirmed that the local mermaid.ink service is running ok:

But my docs are still rendering like so:

For this markdown file: