Diagram Rendering¶

ConfluenceSynkMD can render code blocks for various diagram languages into image attachments that are embedded in your Confluence pages.

Supported Diagram Types¶

Running the published image? All four renderers ship preinstalled in ghcr.io/opendocsync/confluencesynkmd:0.1 — no host-side installation required. Run docker run --rm ghcr.io/opendocsync/confluencesynkmd:0.1 doctor --renderers-only to verify.

Mermaid¶

Mermaid is enabled by default. Write standard Mermaid code blocks:

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Action]
    B -->|No| D[End]
```

Prerequisites¶

• Node.js 22+
• Install mermaid-cli: npm install -g @mermaid-js/mermaid-cli

Disable Mermaid¶

--no-render-mermaid

Draw.io¶

Enable Draw.io rendering to convert Draw.io XML code blocks into images:

--render-drawio

```drawio
<mxfile>...</mxfile>
```

Prerequisites¶

Install drawio-desktop (an Electron app) and arrange a display server (Xvfb on Linux). The simpler path is the published Docker image, which preinstalls drawio-desktop and starts Xvfb on :99 for the container's lifetime via entrypoint.sh. To use it manually, set DRAWIO_CMD to a multi-token invocation:

export DRAWIO_CMD="xvfb-run -a drawio --no-sandbox --disable-gpu"

The DrawioRenderer parses multi-token env values via RendererCommandResolver.

PlantUML¶

Enable PlantUML rendering:

--render-plantuml

```plantuml
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi!
@enduml
```

Prerequisites¶

Install the plantuml binary and ensure it's on your PATH.

LaTeX¶

Enable LaTeX rendering for mathematical formulas:

--render-latex

```latex
E = mc^2
```

Output Format¶

Control the output format for all rendered diagrams:

--diagram-output-format png   # Default
--diagram-output-format svg

Docker¶

The Docker image includes Mermaid by default. For other diagram types, extend the Dockerfile:

# Example: Add PlantUML
RUN apt-get update && apt-get install -y plantuml