Mermaid-Diagramme in Markdown

Mermaid ist eine Möglichkeit, Diagramme mit Text zu zeichnen. Du schreibst ein paar kurze Zeilen. Ein Leser, der Mermaid unterstützt, macht daraus ein Bild: ein Flussdiagramm, eine Zeitleiste, ein Diagramm.

Das Diagramm kannst du in einer normalen Markdown-Datei aufbewahren. Es gibt kein Bild zu exportieren und kein Zeichenprogramm zu öffnen. Um das Diagramm zu ändern, ändere den Text.

Der mermaid-Codeblock

Ein Mermaid-Diagramm steht in einem eingezäunten Codeblock. Ein Zaun besteht aus drei Backticks. Schreibe nach dem öffnenden Zaun mermaid als Sprache:

```mermaid
flowchart LR
    A --> B
```

Die erste Zeile im Block sagt, um welche Art von Diagramm es sich handelt. Hier ist es flowchart LR. Alles nach dieser Zeile beschreibt das Diagramm.

Zeilen, die mit %% beginnen, sind Kommentare. Der Leser ignoriert sie.

Beispiel 1: ein Flussdiagramm mit einer Entscheidung

```mermaid
flowchart TD
    Start[Write the note] --> Check{Is it clear?}
    Check -->|Yes| Publish[Share it]
    Check -->|No| Edit[Rewrite it]
    Edit --> Check
```

So liest du es:

Beispiel 2: ein Sequenzdiagramm

Ein Sequenzdiagramm zeigt, wer mit wem spricht, in der richtigen Reihenfolge.

```mermaid
sequenceDiagram
    participant U as User
    participant S as Server
    U->>S: Open the page
    S-->>U: Send the page
    U->>S: Log in
    S-->>U: Welcome
```

Beispiel 3: ein Kreisdiagramm

```mermaid
pie title Time spent on a project
    "Writing" : 40
    "Reading" : 25
    "Meetings" : 15
    "Other" : 20
```

Jedes Stück besteht aus einer Beschriftung in Anführungszeichen, einem Doppelpunkt und einer Zahl. Die Zahl muss größer als null sein.

Andere Diagrammtypen

Mermaid kann viele weitere Arten zeichnen. Die gängigen:

Jeder Typ hat sein eigenes erstes Wort und seine eigenen Regeln. Die Mermaid-Dokumentation hat für jeden eine eigene Seite.

Wo Mermaid-Diagramme gezeichnet werden

GitHub zeichnet Mermaid-Blöcke in Markdown-Dateien, Issues, Diskussionen, Pull Requests und Wikis. Du brauchst nur den mermaid-Codeblock. Viele Markdown-Editoren und Notiz-Apps unterstützen Mermaid ebenfalls, aber nicht alle.

Wenn ein Leser Mermaid nicht unterstützt, behandelt er den Block meist wie jeden anderen Code. Du siehst den Text, den du geschrieben hast, kein Bild. Nichts geht verloren. Es wird nur nicht gezeichnet.

Häufige Fehler

Einrückung ist nicht nötig. Die meisten rücken die Zeilen in einem Diagramm nur ein, weil es sich leichter lesen lässt.

KI-Chats und Agenten schreiben Mermaid

KI-Chats und Coding-Agenten setzen Mermaid oft in Pläne, Spezifikationen und Entwurfsnotizen. Ein Flussdiagramm ist ein schneller Weg, Schritte zu zeigen. Ein Sequenzdiagramm zeigt, wie Teile eines Systems miteinander sprechen.

Wenn ein Chat dir ein Diagramm gibt, kopiere den ganzen Codeblock, einschließlich der Zäune, in deine Markdown-Datei. Wenn das Diagramm nicht gezeichnet wird, prüfe es anhand der obigen Fehler. Kurze Beschriftungen und eine Idee pro Diagramm machen den Text leichter zu korrigieren.

Mermaid-Diagramme lesen

PilcrowMD zeichnet Mermaid-Diagramme auf Android und auf dem Mac, ohne dass Internet nötig ist. Auf Android tippst du auf ein Diagramm, um es im Vollbild zu sehen. Auf dem Mac zeigen Quick Look, „Vergleichen“ und PDF den Codeblock statt des Bildes.

Häufige Fragen

Muss ich etwas installieren, um Mermaid zu schreiben? Nein. Du schreibst einfachen Text in einen Codeblock. Du brauchst nur einen Leser, der ihn zeichnet.

Warum sehe ich Code statt eines Diagramms? Entweder unterstützt der Leser Mermaid nicht, oder das Diagramm hat einen Syntaxfehler. Prüfe, ob der Block mit mermaid beginnt und ob die erste Zeile einen echten Diagrammtyp nennt.

Kann ich ändern, wie ein Diagramm aussieht? Ja. Mermaid hat Optionen für Farben, Formen und Layout. Beginne mit den Standardwerten. Sie reichen für die meisten Notizen.

Auch für Mac: PilcrowMD für Mac (Beta)