Engine + Framework

PlantUML with Hugo

Integration guide for teams shipping diagram rendering in Hugo.

PlantUML usage guidance

Best for

  • UML modeling
  • Class and sequence diagrams
  • Architecture documentation

Syntax tip

Use explicit participant aliases and avoid deeply nested groups for better readability.

Quick start

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

Recommended flow

  1. Store your PlantUML 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

PlantUML integration details

FieldValue
EnginePlantUML
FrameworkHugo

Hugo implementation checklist

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

PlantUML source example

@startuml
actor User
User -> API: Request
API --> User: Response
@enduml

PlantUML in Hugo: quick comparison

Why teams usually prefer the ChartQuery API pattern over direct client-side rendering for PlantUML 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 PlantUML 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

Same framework, other engines

MermaidGraphVizC4 with PlantUMLD2StructurizrUMletNomnomlSvgbobExcalidrawdiagrams.net (experimental)BPMNBlockDiagSeqDiagActDiagNwDiagPacketDiagRackDiagBytefieldDitaaErdPikchrSymbolatorVegaVega-LiteWaveDromWireViz

Same engine, other frameworks

PlantUML with Next.jsPlantUML with NuxtPlantUML with AngularPlantUML with ReactPlantUML with VuePlantUML with SvelteKitPlantUML with AstroPlantUML with GatsbyPlantUML with RemixPlantUML with SolidStartPlantUML with QwikPlantUML with Ember.jsPlantUML with PreactPlantUML with LitPlantUML with Alpine.jsPlantUML with Ionic ReactPlantUML with Ionic VuePlantUML with Ionic AngularPlantUML with StencilPlantUML with MithrilPlantUML with MarkoPlantUML with Backbone.jsPlantUML with jQueryPlantUML with DocusaurusPlantUML with Eleventy (11ty)PlantUML with VitePlantUML with Fresh (Deno)PlantUML with AnalogJSPlantUML with Aurelia

Start generating charts today

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

Get StartedView Pricing