mermaid

Render Mermaid diagrams to images for inline use (e.g. Slack canvases).

Usage

GET /render/<deflate+base64url>.png    # recommended for Slack canvases (URL ends in .png)
GET /render/<deflate+base64url>.svg
GET /render.png?pako=<deflate+base64url>    # equivalent, query-string form
GET /render.svg?pako=<deflate+base64url>
GET /?code=<urlencoded mermaid>[&format=png|svg][&theme=...][&scale=1-5][&bgColor=...]

Parameters

• code — URL-encoded Mermaid source
• pako — deflate-compressed, base64url-encoded Mermaid source (much shorter URLs; required when an image proxy caps URL length)
• source — base64-encoded Mermaid source (legacy alias)
• format — png (default) or svg
• theme — default, forest, dark, neutral
• scale — device scale factor 1-5 (default 1; use 2 for retina)
• bgColor — hex without #, or transparent (default white)
• width, height — viewport hints (default 800x600)

Example

/?code=flowchart%20TD%0A%20%20A%5BBoot%5D%20--%3E%20B%5BReady%5D

Errors

Parse and render failures return HTTP 400 with the underlying mermaid error in the response body.