Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quickstart

Write a flowchart:

flowchart LR
    A[Start] --> B{Ok?}
    B -->|yes| C[Done]
    B -->|no| D[Retry] --> B
the drawing of the mermaid source above

Save it as diagram.mmd, then:

sirene ascii diagram.mmd     # print it in the terminal
sirene svg diagram.mmd -o diagram.svg
sirene png diagram.mmd       # writes diagram.png
sirene diagram.mmd           # open it in the editor

sirene with no file opens a new document with a starter flowchart.

In the editor

  • Type in the source pane; the drawing follows as you type.
  • Click a node to select it, double-click (or press enter) to edit its label.
  • Drag from one node to another to connect them.
  • Press secondary-shift-n to add a node after the selected one. Secondary is Cmd on macOS and Ctrl elsewhere.
  • Press backspace to delete the selection, secondary-z to undo.
  • Secondary-s saves.

Every change made in the drawing is an ordinary text edit to the source, so comments, spacing, and statement order are kept. See The editor.

Keeping images up to date

sirene png --watch docs/

writes a .png beside each diagram file (.mmd, .puml, .dot, and the other extensions) under docs/, then writes it again each time one changes. See Command line.

Other languages

PlantUML and Graphviz DOT files render the same way, with the drawing read-only in the editor:

@startuml
Alice -> Bob : hello
Bob --> Alice : hi
@enduml
the drawing of the plantuml source above
sirene ascii hello.puml
printf 'digraph { a -> b -> c }\n' | sirene ascii

See PlantUML and Graphviz DOT.