Documentation
Meltemi Diagrams turns .meltemi text files into professional diagrams, edited as code or on a
canvas, animated, and exported for documents, slides, the web and video.
- Getting started: install, a first project, the canvas and the exports.
- Features: everything 1.0 does, by area.
- Gallery and the purchase example.
- Compatibility and known limitations.
Coming from another tool
Section titled “Coming from another tool”- From Mermaid
- From PlantUML
- From a visual editor such as draw.io, Lucidchart or Visio
The language
Section titled “The language”| Topic | Reference |
|---|---|
| Syntax, flow diagrams, placement and styles | grammar |
| Free compositions | free |
| Sequence diagrams and scenarios | sequence |
| Models and C4 views | C4 |
| Layout, ports, constraints and checks | layout |
| Themes, classes and presets | styles |
| Icons, images and fonts | assets, fonts |
| Motion effects and stories | motion, stories |
| Exports and export profiles | export, SVG |
| Projects and imports between files | projects |
| Formatting | formatting |
| Every diagnostic | diagnostics |
| The model JSON interchange format | model JSON |
| How the language changes, and how implementations conform | policy, conformance |
- The command line:
init,preview,validate,format,layout,import,export,build catalog,review,assist, CI, and the cloud commands (login,push,pull,publish,projects) that keep a project in step with the cloud service. - The editor for VS Code: language features and the canvas.
- The web app: everything in a browser tab, and projects in the cloud when you sign in, shared by link, with people, worked on together live and published as web pages.
- The cloud service: the Worker behind the hosted web app, with its optional account, API tokens, the command line’s sign-in and projects kept in the cloud: rooms, versions, thumbnails and quotas; sharing and permissions; the presence the room relays; and publishing on a host of its own.
- The HTML player and the catalog.
- Importing Mermaid and PlantUML: what each construct becomes.
- AI assistance, optional.
- Drawing with coding agents: the one prompt that sets up a coding agent, the skill,
skill installand the agent setup page athttps://diagrams.meltemi.dev/agent-setup/. - Plugins and safety.
Quality and project
Section titled “Quality and project”- Quality and acceptance, with the latest results, performance and the export checks in browsers and office applications.
- Contributing, governance, security policy and releasing.
- Changelog, the 1.0 roadmap and the decision notes.
- Pilot protocol and launch material.