Du schreibst ein README mit verschachtelten Aufzählungspunkten, ein paar Code-Blöcken und einer Tabelle, die zwei Ansätze vergleicht. Es sieht als Klartext in deinem Editor gut aus. Dann pushst du es auf GitHub und die Tabelle ist falsch ausgerichtet, einer deiner Code-Blöcke wurde nicht richtig geschlossen, und eine nummerierte Liste hat mittendrin bei 1 neu angefangen wegen einer streunenden Leerzeile. Jetzt pushst du kleine Fixup-Commits, nur um die Formatierung hinzubekommen.
Markdown ist einfach genug, um es für grundlegende Formatierung aus dem Gedächtnis zu schreiben, aber Tabellen, verschachtelte Listen und Code-Fences haben alle kleine Syntaxeigenheiten, die sich zwischen Renderern leicht unterscheiden. GitHub Flavored Markdown ist nicht identisch mit CommonMark, das nicht identisch ist mit dem, was dein Static-Site-Generator verwendet. Die Lücke zwischen „sieht in meinem Kopf richtig aus" und „rendert richtig auf der Seite" ist genau dort, wo eine Live-Vorschau ihren Wert beweist.
Warum Committen zum Prüfen ein schlechter Workflow ist
Einen Commit zu pushen, nur um zu sehen, wie ein README rendert, dann einen weiteren, um eine kaputte Tabelle zu reparieren, dann noch einen, um die Reparatur zu reparieren, überfüllt deine Commit-Historie mit Formatierungsrauschen, das nichts mit dem eigentlichen Inhalt zu tun hat. Es bedeutet auch, dass jeder Vorschau-Zyklus so lange dauert wie ein Push und ein Seitenneuladen — langsam genug, dass du aufhörst zu prüfen und einfach hoffst, dass es gut aussieht.
Gerenderte Ausgabe sehen, während du tippst
Bellows enthält ein Markdown-Vorschau-Tool, das formatierte Ausgabe rendert, während du rohes Markdown einfügst oder tippst. Überschriften, Listen, Tabellen, Links und Code-Blöcke werden sofort gerendert, sodass du Formatierungsfehler erkennen kannst, bevor sie in einem Commit landen.
READMEs und PR-Beschreibungen schreiben
Pull-Request-Beschreibungen und README-Dateien sind oft das Erste, was ein Reviewer oder neuer Contributor liest. Zu prüfen, ob Überschriften, Checklisten und verlinkte Bilder korrekt rendern, bevor du einreichst, spart eine Runde „kannst du die Formatierung fixen"-Kommentare.
Dokumentation offline entwerfen
Dokumentation im Flugzeug oder in einem Gebiet mit unzuverlässigem Internet zu schreiben bedeutet nicht, darauf verzichten zu müssen, deine Formatierung korrekt gerendert zu sehen. Ein lokales Vorschau-Tool funktioniert gleich, egal ob du verbunden bist oder nicht.