Markdown-Vorschau

Der ganze Reiz von Markdown ist, dass es als Klartext geschrieben und gelesen werden kann, aber genau diese Einfachheit ist es, was bestimmte Fehler unsichtbar macht, bis sie gerendert werden — eine Tabelle, der ein vertikaler Strich in ihrer Trennzeile fehlt, fällt still zurück, als flacher Absatz statt einer Tabelle angezeigt zu werden, eine verschachtelte Liste, eingerückt mit der falschen Anzahl Leerzeichen, wird an das falsche Elternelement angehängt, und es gibt keine Fehlermeldung für beide Probleme, nur eine Ausgabe, die still nicht so aussieht wie beabsichtigt. Das echte gerenderte Ergebnis kontinuierlich beim Tippen aktualisieren zu sehen erkennt genau diese Art von Formatierungsfehler in dem Moment, in dem er eingeführt wird, was deutlich schneller ist, als ein ganzes README oder eine Pull-Request-Beschreibung blind zu schreiben und erst zu entdecken, dass die Formatierung kaputtging, nachdem es bereits irgendwo veröffentlicht wurde.

GitHub, eine Dokumentations-Website, und ein Forenbeitrag können denselben Markdown-Quellcode bei Randfällen leicht unterschiedlich rendern, selbst wenn sie alle weithin GFM unterstützen, daher lohnt sich das Prüfen vor der Veröffentlichung besonders, wenn das Ziel eines ist, bei dem ein Rendering-Fehler für ein großes Publikum sichtbar wäre — ein öffentliches README, eine Ankündigung, oder eine Pull-Request-Beschreibung, die Prüfer wirklich aufmerksam lesen werden.