Skip to content

Commit 010b114

Browse files
committed
Add a callout in diagram about setting SVG format for PDF
1 parent 2994abe commit 010b114

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/authoring/diagrams.qmd

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,18 @@ format:
200200

201201
Valid values for `mermaid-format` include `js`, `png`, and `svg`,
202202

203+
::: callout-warning
204+
## SVG Format Limitations with PDF Output
205+
206+
When rendering to PDF or LaTeX-based formats, `mermaid-format: svg` requires additional tooling and may have rendering issues:
207+
208+
- **Requires installation:** `rsvg-convert` must be available in your system PATH
209+
- **Potential rendering issues:** Text clipping in diagrams with multi-line labels
210+
- **Recommended:** Use default `mermaid-format: png` for PDF output
211+
212+
For installation instructions, see [SVG Images](/docs/output-formats/pdf-basics.qmd#svg-images).
213+
:::
214+
203215
## Mermaid Themes {#mermaid-theming}
204216

205217
{{< include _mermaid-theming.qmd >}}

0 commit comments

Comments
 (0)