Skip to content

Guide ​

The guide explains umlimator by task. Start with Getting started, then read the pages you need.

PageWhat it covers
Getting startedinstall, a first model, and a map in a page
The modelcards, lines, boxes and views: the JSON every tool reads, and its schema
Views and layersdrill-down, stacked cards, paths, overlays and rules
Embeddingrender(), the <umlimator-map> element, React, VitePress and Docusaurus
The standalone pagethe self-contained HTML page the CLI writes, and its links
Editinggestures, events and apply(): changing a model from the canvas
Stories, lenses and live datawalk-throughs, saved ways to look at a map, and traffic drawn over it
Command lineumlimator.py: render, stills, check, PDF, diff, drift, import and more
GitHub Action and diffwhat a pull request changes in your maps, posted on it; rules in CI
MCP serveran AI assistant that reads the model and drives its page
Import and exportStructurizr, C4-PlantUML, Mermaid, DBML, BPMN XML, compose and Kubernetes
Icons and icon packslogos, line icons, and the cloud vendors' icon packs

For every export, its options and its events, see the API reference. For the 28 diagram types, see Diagram types.