Diagram Rendering¶
ConfluenceSynkMD can render code blocks for various diagram languages into image attachments that are embedded in your Confluence pages.
Supported Diagram Types¶
| Type | Flag | Default | External Tool Required |
|---|---|---|---|
| Mermaid | --render-mermaid |
✅ Enabled | Docker Engine (mermaid-cli container) |
| Draw.io | --render-drawio |
❌ Disabled | drawio-export |
| PlantUML | --render-plantuml |
❌ Disabled | plantuml binary |
| LaTeX | --render-latex |
❌ Disabled | LaTeX distribution |
Mermaid¶
Mermaid is enabled by default. Write standard Mermaid code blocks:
Prerequisites¶
- Docker Engine installed and running
- Docker executable available on your
PATH
Disable Mermaid¶
Draw.io¶
Enable Draw.io rendering to convert Draw.io XML code blocks into images:
Prerequisites¶
Install drawio-export or use the Docker image which can be extended to include it.
PlantUML¶
Enable PlantUML rendering:
Prerequisites¶
Install the plantuml binary and ensure it's on your PATH.
LaTeX¶
Enable LaTeX rendering for mathematical formulas:
Output Format¶
Control the output format for all rendered diagrams:
Tip
Use --prefer-raster to force raster output (PNG) even when the renderer produces SVG by default.
Docker¶
The Docker image includes Mermaid by default. For other diagram types, extend the Dockerfile: