Engine + Framework

WaveDrom with Hugo

Integration guide for teams shipping diagram rendering in Hugo.

WaveDrom usage guidance

Best for

  • General diagram rendering
  • Programmatic documentation pipelines
  • Automated visual generation

Syntax tip

Keep WaveDrom source deterministic and reusable across environments.

Quick start

Use a Hugo shortcode with resources.GetRemote to render WaveDrom diagrams at build time.

Recommended flow

  1. Store your WaveDrom source in code or markdown.
  2. Send source to a server-side endpoint backed by ChartQuery.
  3. Render returned SVG/PNG in Hugo pages and docs.

Typical Hugo integration path: /layouts/shortcodes/diagram.html

WaveDrom integration details

FieldValue
EngineWaveDrom
FrameworkHugo

Hugo implementation checklist

  • Use shortcode for diagram blocks
  • Call remote renderer at build time
  • Add security allowlist for outbound requests

WaveDrom source example

// WaveDrom source
// Add your diagram content here

WaveDrom in Hugo: quick comparison

Why teams usually prefer the ChartQuery API pattern over direct client-side rendering for WaveDrom in Hugo.

Feature
Hugo native setup
ChartQuery API setup
Server-side rendering without browser dependencies
Unified output (SVG/PNG) for docs, dashboards, and emails
Consistent rendering across environments
Works with CI/CD pipelines
Fits backend-first architectures
Single rendering workflow across multiple frameworks

Ship WaveDrom in Hugo faster

Use ChartQuery to standardize diagram rendering across your stack with one API, one workflow, and predictable output quality.

Get started with ChartQuery

Start generating charts today

No API key required to get started. Generate charts, diagrams, and more with a single HTTP request.

Get StartedView Pricing