Je schrijft een README met geneste opsommingstekens, een paar codeblokken en een tabel die twee benaderingen vergelijkt. Het ziet er prima uit als platte tekst in je editor. Dan push je het naar GitHub en blijkt de tabel scheef uitgelijnd, is een van je codeblokken niet correct gesloten, en begint een genummerde lijst halverwege opnieuw bij 1 vanwege een verdwaalde lege regel. Nu push je kleine fixup-commits alleen om de opmaak goed te krijgen.
Markdown is simpel genoeg om uit het hoofd te schrijven voor basisopmaak, maar tabellen, geneste lijsten en codefences hebben allemaal kleine syntax-eigenaardigheden die enigszins verschillen tussen renderers. GitHub Flavored Markdown is niet identiek aan CommonMark, wat weer niet identiek is aan wat je statische sitegenerator gebruikt. Het gat tussen "ziet er goed uit in mijn hoofd" en "wordt goed weergegeven op de pagina" is precies waar een live preview zijn nut bewijst.
Waarom committen om te controleren een slechte workflow is
Een commit pushen alleen om te zien hoe een README wordt weergegeven, dan nog een pushen om een kapotte tabel te herstellen, dan nog een om de fix te herstellen, verstopt je commit-geschiedenis met opmaakruis die niets met de eigenlijke inhoud te maken heeft. Het betekent ook dat elke previewronde net zo lang duurt als een push en een paginaherlading — traag genoeg dat je stopt met controleren en gewoon hoopt dat het er goed uitziet.
Zie gerenderde uitvoer terwijl je typt
Bellows bevat een Markdown-previewtool die geformatteerde uitvoer weergeeft terwijl je ruwe Markdown plakt of typt. Kopteksten, lijsten, tabellen, links en codeblokken worden allemaal direct gerenderd, zodat je opmaakfouten kunt opvangen voordat ze in een commit terechtkomen.
README's en PR-beschrijvingen schrijven
Pull request-beschrijvingen en README-bestanden zijn vaak het eerste wat een reviewer of nieuwe bijdrager leest. Controleren dat kopteksten, checklists en gelinkte afbeeldingen correct worden weergegeven voordat je indient, bespaart een ronde van "kun je de opmaak repareren"-reacties.
Documentatie offline opstellen
Documentatie schrijven op een vlucht of in een gebied met onbetrouwbaar internet hoeft niet te betekenen dat je je opmaak niet correct kunt bekijken. Een lokale previewtool werkt hetzelfde, of je nu verbonden bent of niet.