Guide
The guide explains umlimator by task. Start with Getting started, then read the pages you need.
| Page | What it covers |
|---|---|
| Getting started | install, a first model, and a map in a page |
| The model | cards, lines, boxes and views: the JSON every tool reads, and its schema |
| Views and layers | drill-down, stacked cards, paths, overlays and rules |
| Embedding | render(), the <umlimator-map> element, React, VitePress and Docusaurus |
| The standalone page | the self-contained HTML page the CLI writes, and its links |
| Editing | gestures, events and apply(): changing a model from the canvas |
| Stories, lenses and live data | walk-throughs, saved ways to look at a map, and traffic drawn over it |
| Command line | umlimator.py: render, stills, check, PDF, diff, drift, import and more |
| GitHub Action and diff | what a pull request changes in your maps, posted on it; rules in CI |
| MCP server | an AI assistant that reads the model and drives its page |
| Import and export | Structurizr, C4-PlantUML, Mermaid, DBML, BPMN XML, compose and Kubernetes |
| Icons and icon packs | logos, 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.