Markdown formatieren und die Struktur lesbar machen
Markdown-Formatierung soll einen Text leichter lesbar machen, ohne den Inhalt zu verändern. Gute Formatierung nutzt Überschriften, Listen, Tabellen und Codeblöcke dort, wo sie die Struktur klarer machen.
Nutze den Markdown-Formatierer für Notizen, Dokumentation, Changelogs oder kopierte Inhalte, die sauberes Markdown brauchen.
Was gute Markdown-Formatierung macht
Ein formatierter Markdown-Text zeigt die Hierarchie. Hauptabschnitte werden Überschriften. Zusammengehörige Punkte werden Listen. Vergleiche können Tabellen werden. Befehle und Code gehören in Codeblöcke.
Aus einer rohen Notiz wie „Setup Pakete installieren Migrationen ausführen Queue neu starten Logs prüfen“ kann werden:
## Setup
- Pakete installieren
- Migrationen ausführen
- Queue neu starten
- Logs prüfen
Die Information bleibt gleich, aber die Struktur ist klarer.
Inhalt bewahren
Formatierung sollte keine Schritte erfinden und keine Warnungen entfernen. Wenn im Original steht, dass ein Schritt optional ist, muss das erhalten bleiben. Wenn ein Befehl nicht in Produktion ausgeführt werden darf, gehört die Warnung weiterhin zum Befehl.
Nummerierte Listen passen nur, wenn die Reihenfolge wichtig ist. Sonst sind Stichpunkte oft besser.
Tabellen und Codeblöcke
Tabellen eignen sich für Optionen, Status, Preise oder Vergleiche. Lange Fließtexte werden dadurch meist schlechter lesbar.
Codeblöcke eignen sich für Befehle, Konfigurationen und Beispiele. Prüfe Pfade, Anführungszeichen und Flags besonders sorgfältig.
Nutze HTML formatieren, wenn dein Ausgangstext HTML ist. Nutze Markdown formatieren, wenn du sauberes Markdown brauchst.