Skip to main content
CheckTown
Dev-Tools

Markdown-Tabellen: Syntax, Ausrichtung und Tipps für saubere Doku

Veröffentlicht 6 Min. Lesezeit
In diesem Artikel

Was sind Markdown-Tabellen?

Markdown-Tabellen nutzen Pipe-Zeichen (|) und Bindestriche (-), um strukturierte tabellarische Daten innerhalb von Klartextdokumenten zu erstellen. Sie sind Teil von GitHub Flavored Markdown (GFM) und werden von den meisten Markdown-Renderern unterstützt, darunter GitHub, GitLab, VS Code und Static-Site-Generatoren.

Tabellen in Markdown sind für die einfache Darstellung von Daten gedacht — Spaltenüberschriften, Trennzeile und Datenzeilen. In der Ausgabe werden sie als echte HTML-Tabellen gerendert, was sie ideal für Dokumentationen, README-Dateien und technische Texte macht, ganz ohne HTML-Kenntnisse.

Syntax von Markdown-Tabellen

Eine Markdown-Tabelle besteht aus drei Teilen: der Kopfzeile, der Trennzeile und einer oder mehreren Datenzeilen.

  • Kopfzeile — die erste Zeile legt die Spaltennamen fest, getrennt durch Pipe-Zeichen (|). Führende und abschließende Pipes sind optional, aus Gründen der Übersichtlichkeit aber empfehlenswert.
  • Trennzeile — die zweite Zeile verwendet Bindestriche (---) zwischen den Pipes, um den Kopf von den Daten zu trennen. Pro Spalte sind mindestens drei Bindestriche erforderlich.
  • Datenzeilen — jede weitere Zeile enthält Zellwerte, die durch Pipes getrennt sind. Die Zellen müssen nicht optisch ausgerichtet sein, doch ausgerichtete Spalten verbessern die Lesbarkeit des Quelltexts.
  • Pipes maskieren — enthält ein Zellinhalt ein wörtliches Pipe-Zeichen, maskieren Sie es mit einem Backslash (\|), damit es nicht als Spaltentrenner interpretiert wird.

Optionen zur Spaltenausrichtung

Die Spaltenausrichtung wird gesteuert, indem der Trennzeile Doppelpunkte hinzugefügt werden. Damit legen Sie fest, wie der Text innerhalb der jeweiligen Spalte ausgerichtet wird.

  • Linksbündig (Standard) — verwenden Sie :--- oder --- in der Trennzeile. Der Text wird am linken Rand der Spalte ausgerichtet. Dies ist die Voreinstellung, wenn keine Doppelpunkte angegeben sind.
  • Zentriert — verwenden Sie :---: in der Trennzeile. Der Text wird innerhalb der Spalte zentriert. Praktisch für Statusbezeichnungen, Kategorien oder kurze Werte.
  • Rechtsbündig — verwenden Sie ---: in der Trennzeile. Der Text wird am rechten Rand ausgerichtet. Ideal für Zahlenwerte, Preise, Anzahlen und Messwerte.

Kostenlos testen – keine Registrierung erforderlich

Markdown-Tabellen erstellen →

Häufige Anwendungsfälle

Markdown-Tabellen kommen überall dort zum Einsatz, wo strukturierte Daten in Dokumentationen dargestellt werden müssen.

  • README-Dokumentation — Tabellen zum Vergleich von Projektfunktionen, Installationsvoraussetzungen, unterstützten Plattformen und Versionskompatibilitäts-Matrizen
  • API-Dokumentation — Endpunkt-Referenzen mit Methode, Pfad, Beschreibung und Parametertabellen für jede Route
  • Vergleichstabellen — Funktionsvergleiche nebeneinander, Preisstufen und Tool-Bewertungen in Blogbeiträgen und technischen Reviews
  • Changelogs — Versionsverlaufstabellen mit Datum, Versionsnummer und Beschreibung der Änderungen für jedes Release

Tipps und bewährte Vorgehensweisen

Wenn Sie diese Richtlinien befolgen, bleiben Ihre Markdown-Tabellen sowohl im Quelltext als auch in der gerenderten Form gut lesbar.

  • Spalten im Quelltext ausrichten — füllen Sie Zellen mit Leerzeichen auf, damit die Spalten optisch fluchten. Die meisten Editoren und unser Generator erledigen das automatisch. Ausgerichteter Quelltext lässt sich in Pull Requests deutlich leichter prüfen.
  • Komplexe Inhalte in Zellen vermeiden — Markdown-Tabellen unterstützen keine mehrzeiligen Zellinhalte, keine Blockelemente und keine verschachtelten Tabellen. Halten Sie Zellinhalte kurz und einfach. Für komplexe Daten sollten Sie stattdessen HTML-Tabellen verwenden.
  • Spaltenanzahl begrenzen — Tabellen mit mehr als 5 bis 6 Spalten werden auf kleineren Bildschirmen schwer lesbar. Erwägen Sie, breite Tabellen in mehrere fokussierte Tabellen aufzuteilen oder für sehr breite Daten ein anderes Format zu verwenden.

Häufig gestellte Fragen

Gibt es eine Begrenzung für den Zellinhalt in Markdown-Tabellen?

Es gibt keine technische Zeichenbegrenzung für den Zellinhalt, aber Markdown-Tabellenzellen sind stets einzeilig. Sie können weder Zeilenumbrüche noch Absätze oder Blockelemente wie Listen innerhalb einer Zelle einfügen. Für komplexe Zellinhalte verwenden Sie HTML-Tabellen mit <td>-Elementen, die beliebige HTML-Inhalte unterstützen.

Kann ich Zellen in Markdown-Tabellen verbinden?

Nein. Standard-Markdown-Tabellen unterstützen weder colspan noch rowspan — jede Zeile muss dieselbe Anzahl an Spalten haben. Das Verbinden von Zellen erfordert HTML-Tabellen. Wenn Sie verbundene Zellen benötigen, schreiben Sie die Tabelle in HTML und betten Sie sie direkt in Ihr Markdown-Dokument ein.

Kann ich Tabellen in Markdown-Tabellen verschachteln?

Nein. Markdown-Tabellen lassen sich nicht verschachteln. Jede Tabelle ist ein flaches Raster aus Zeilen und Spalten. Wenn Sie hierarchische Daten benötigen, erwägen Sie verschachtelte Listen, separate Tabellen mit Überschriften oder HTML-Tabellen mit verschachtelten <table>-Elementen.

Verwandte Tools