Mermaid-Tutorial: Flussdiagramme, Sequenzdiagramme und Gantt-Charts

Mit Mermaid beschreibst du ein Diagramm als Text. Keine Kästchen zum Verschieben, keine Bilddateien zum Pflegen: Ein paar Zeilen in deinem Markdown genügen, und der Viewer zeichnet das Diagramm. Textdiagramme sind leicht zu ändern, funktionieren hervorragend mit Versionskontrolle und werden von GitHub, GitLab, Notion und Moread unterstützt.

Mermaid in Markdown einfügen

Öffne einen Codeblock mit drei Backticks und setze die Sprache auf mermaid:

```mermaid
flowchart LR
    A[Start] --> B[Ende]
```

Speichere das in einer .md-Datei, öffne sie in Moread und du siehst ein Flussdiagramm von links nach rechts. Mit Vergrößern am Diagramm zoomst du hinein.

Flussdiagramme

Die erste Zeile legt die Richtung fest: TD (von oben nach unten) oder LR (von links nach rechts). Die Klammerform bestimmt die Form der Knoten:

flowchart TD
    A[Rechteck] --> B(Abgerundet)
    B --> C{Entscheidung}
    C -->|Ja| D[[Unterprozess]]
    C -->|Nein| E((Kreis))
  • --> ist ein Pfeil, --- eine einfache Linie und -.-> ein gestrichelter Pfeil.
  • |Text| beschriftet einen Pfeil, meist mit einer Bedingung.
  • Knoten-IDs (A, B, C) müssen nur eindeutig sein; angezeigt wird der Text in den Klammern.

Sequenzdiagramme

Ideal, um den zeitlichen Ablauf zwischen Nutzern und Systemen zu zeigen:

sequenceDiagram
    participant U as Nutzer
    participant S as Server
    U->>S: Login senden
    S-->>U: Ergebnis zurückgeben
    Note over U,S: Alles läuft über HTTPS

->> ist ein durchgezogener Pfeil (Anfrage), -->> ein gestrichelter (Antwort). Mit Note over fügst du Notizen hinzu.

Gantt-Charts

Projektpläne auf einen Blick:

gantt
    title Website-Relaunch
    dateFormat YYYY-MM-DD
    section Konzept
    Interviews :a1, 2025-01-06, 5d
    UI-Design :after a1, 7d
    section Umsetzung
    Frontend :2025-01-20, 10d
    Test und Livegang :5d

Tortendiagramme

pie title Ein typischer Tag
    "Arbeit" : 8
    "Schlaf" : 7
    "Lesen" : 2
    "Sonstiges" : 7

Zustandsdiagramme

stateDiagram-v2
    [*] --> Entwurf
    Entwurf --> Prüfung: Einreichen
    Prüfung --> Veröffentlicht: Freigeben
    Prüfung --> Entwurf: Zurückweisen
    Veröffentlicht --> [*]

Fehlerbehebung

  • Das Diagramm erscheint nicht: Prüfe, ob der Codeblock die Sprache mermaid hat und die erste Zeile einen Diagrammtyp nennt (flowchart, sequenceDiagram usw.).
  • Sonderzeichen in Beschriftungen: Setze Beschriftungen mit Klammern oder Doppelpunkten in Anführungszeichen, z. B. A["Preis (inkl. MwSt.)"].
  • Falsche Richtungsangabe: Nach flowchart sind nur TB, TD, BT, RL oder LR erlaubt.
  • Bei einem Fehler behält Moread den Quelltext, zeigt den Grund an und stellt den Rest des Dokuments normal dar.

Tipps

  • Große Diagramme sind mit der Richtung LR oft besser lesbar.
  • Ein Dokument kann viele Diagramme enthalten; Moread zeichnet bis zu 40 pro Datei.
  • Diagramme folgen dem dunklen Design, und beim PDF-Export wechseln sie zu druckfreundlichen hellen Farben.

Live ansehen? Klicke auf der Moread-Startseite auf Demo: Diagramme · Formeln · Code, um ein Beispieldokument mit Mermaid-Diagrammen zu öffnen.