DevToy

Markdown-Tabellen

Bessere Tabellen für GitHub-README-Dateien gestalten

Ein gut prüfbarer Ablauf für kompakte README-Tabellen mit Überschriften, Ausrichtung, Links, Badges und mobiler Lesbarkeit.

Veröffentlicht 11. Juli 2026 · Aktualisiert 11. Juli 2026

Eine README-Tabelle sollte eine konkrete Frage schneller beantworten: Welches Paket soll installiert werden? Welche Funktion wird unterstützt? Welche Umgebung war erfolgreich? Als allgemeines Seitenlayout oder Behälter für lange Absätze wirkt sie dagegen kontraproduktiv.

Jede Spalte erhält eine Aufgabe

Verwenden Sie kurze, konkrete Überschriften:

| Paket | Laufzeit | Status |
| :--- | :---: | :---: |
| `core` | Node 22 | Stabil |
| `cli` | Node 22 | Beta |

Namen stehen links, kompakte Statusfelder können zentriert und Zahlen rechts ausgerichtet werden. Mehrsätzige Beschreibungen gehören außerhalb der Tabelle.

Aussagekräftige Linktexte bevorzugen

Lange Roh-URLs machen Spalten breit. [API-Referenz](./docs/api.md) hält sie kompakt und beschreibt das Ziel für Screenreader. Badges sind Bilder und erhöhen das visuelle Rauschen; verwenden Sie wenige, laufend aktualisierte Signale mit sinnvollem Alternativtext.

Für Quelltext-Reviews optimieren

Reviewer betrachten Darstellung und Diff. Halten Sie einen Datensatz pro Zeile und vermeiden Sie hunderte manuell ausgerichtete Leerzeichen. Bei generierten Matrizen gehört das Skript oder die Quelldatei ins Repository, damit Werte nachvollziehbar bleiben.

Schmale Bildschirme prüfen

Horizontales Scrollen lässt den Zeilenkontext leicht verloren gehen. Stellen Sie die wichtigste Kennung nach vorn, begrenzen Sie die Spaltenzahl und teilen Sie unabhängige Dimensionen auf. Eine außergewöhnlich lange Zeile gehört wahrscheinlich in einen eigenen Abschnitt.

Aussagen aktuell halten

Funktions- und Supportmatrizen altern schnell. Ändern Sie README und Kompatibilität im selben Pull Request.

Erstellen Sie den Quelltext im Markdown-Tabellengenerator und prüfen Sie die GitHub-Darstellung vor dem Zusammenführen.

Verwandte Anleitungen