Syntax-Referenz

Markdown-Syntax: die Muster, die Sie am häufigsten verwenden

Mit einer kleinen Anzahl von Mustern können Sie nützliches Markdown schreiben. Beginnen Sie mit der semantischen Struktur, lassen Sie Leerzeilen um Blockelemente und sehen Sie sich das Dokument im Renderer an, in dem es veröffentlicht wird.

8 Minuten Lesezeit

Überschriften und Absätze

Stellen Sie einer Überschrift ein bis sechs Rautezeichen voran. Verwenden Sie eine H1 für den Dokumenttitel und steigen Sie dann stufenweise ab, ohne Überschriften nur wegen ihrer visuellen Größe zu wählen. Absätze werden durch eine Leerzeile getrennt.

ÜberschriftenMarkdown
# Document title

An opening paragraph.

## Installation

Setup details.

### Environment variables

Configuration details.

Hervorhebungen, Links und Bilder

Verwenden Sie Sternchen für Hervorhebungen, eckige Klammern für den sichtbaren Linktext und runde Klammern für das Ziel. Die Bildsyntax ergänzt ein Ausrufezeichen; aussagekräftiger Alternativtext bleibt wichtig, wenn das Bild nicht sichtbar ist.

Inline-SyntaxMarkdown
Use **bold** for strong importance and *italic* for emphasis.

Read the [deployment guide](/guides/deploy).

![A diagram of the request flow](request-flow.png)

Listen und Aufgabenlisten

Beginnen Sie ungeordnete Einträge mit einem Bindestrich und geordnete Einträge mit einer Zahl. Rücken Sie verschachtelte Einträge einheitlich ein. Viele Entwicklerplattformen unterstützen über GitHub Flavored Markdown auch Kontrollkästchen für Aufgabenlisten.

ListenMarkdown
- Prepare the release
  - Update the changelog
  - Freeze migrations
- Deploy

1. Start the canary
2. Watch metrics
3. Expand traffic

- [x] Tests pass
- [ ] Docs reviewed

Inline-Code und Code-Blöcke mit Markierungen

Setzen Sie kurze Bezeichner oder Befehle in einzelne Backticks. Legen Sie längere Beispiele zwischen dreifache Backticks und fügen Sie einen Sprachnamen hinzu, wenn der Renderer Syntax-Highlighting unterstützt. Halten Sie ausführbare Beispiele vollständig genug, um sie zu verstehen und zu testen.

CodeMarkdown
Set `SERVICE_URL` in the server environment.

```ts
type Result = {
  markdown: string;
  fileName: string;
};
```

Blockzitate, Trennlinien und Tabellen

Blockzitate eignen sich für zitierte Inhalte oder kurze Hinweise. Horizontale Linien trennen größere Übergänge. Tabellen funktionieren gut bei kompakten, rechteckigen Daten; sie werden schwer lesbar, wenn Zellen lange Fließtexte enthalten oder die Tabelle sehr breit ist.

GFM-TabelleMarkdown
> Conversion preserves structure, not pixel-perfect layout.

---

| Format | Good for | Review |
| --- | --- | --- |
| DOCX | Styled prose | Tables |
| CSV | Small datasets | Escaping |

Schreiben Sie Syntax, die verschiedene Renderer übersteht

Lassen Sie Leerzeilen um Überschriften, Listen, Tabellen und Code-Blöcke mit Markierungen. Bevorzugen Sie beschreibende Links gegenüber nackten URLs. Vermeiden Sie rohes HTML, es sei denn, das Publishing-System unterstützt und bereinigt es ausdrücklich. Wenn eine Funktion plattformspezifisch ist, nehmen Sie genügend einfachen Text auf, damit das Dokument auch anderswo Sinn ergibt.

Eine Vorschau zeigt, wie das Dokument hier gerendert wird; Ihr Ziel-Repository oder Dokumentationssystem bleibt der endgültige Kompatibilitätstest.

Üben Sie die Syntax mit Live-Vorschau

Öffnen Sie einen lokalen Entwurf und sehen Sie, wie Überschriften, Listen, Code und Tabellen beim Tippen gerendert werden.

Editor ausprobieren