Vous écrivez un README avec des puces imbriquées, quelques blocs de code, et un tableau comparant deux approches. Ça a l'air correct en texte brut dans votre éditeur. Puis vous le poussez sur GitHub et le tableau est mal aligné, l'un de vos blocs de code ne s'est pas fermé correctement, et une liste numérotée redémarre à 1 au milieu à cause d'une ligne vide égarée. Vous voilà à pousser de petits commits correctifs juste pour obtenir le bon formatage.
Le Markdown est assez simple pour être écrit de mémoire pour du formatage basique, mais les tableaux, les listes imbriquées et les blocs de code ont tous de petites bizarreries de syntaxe qui diffèrent légèrement selon les moteurs de rendu. Le GitHub Flavored Markdown n'est pas identique au CommonMark, qui n'est pas identique à ce qu'utilise votre générateur de site statique. L'écart entre « ça a l'air correct dans ma tête » et « ça s'affiche correctement sur la page » est exactement là qu'un aperçu en direct fait ses preuves.
Pourquoi valider un commit juste pour vérifier est un mauvais flux de travail
Pousser un commit juste pour voir comment un README s'affiche, puis un autre pour corriger un tableau cassé, puis un autre pour corriger la correction, encombre votre historique de commits avec du bruit de formatage qui n'a rien à voir avec le contenu réel. Cela signifie aussi que chaque cycle de prévisualisation prend autant de temps qu'un push et un rechargement de page — assez lent pour que vous cessiez de vous en préoccuper et espériez simplement que ça ait l'air correct.
Voir le résultat rendu au fur et à mesure de la saisie
Bellows inclut un outil d'aperçu Markdown qui affiche le résultat formaté pendant que vous collez ou tapez du Markdown brut. Titres, listes, tableaux, liens et blocs de code s'affichent immédiatement, pour que vous puissiez repérer les erreurs de formatage avant qu'elles ne se retrouvent dans un commit.
Écrire des README et des descriptions de PR
Les descriptions de pull requests et les fichiers README sont souvent la première chose qu'un relecteur ou un nouveau contributeur lit. Vérifier que les titres, les listes de contrôle et les images liées s'affichent correctement avant de soumettre vous évite une série de commentaires du type « peux-tu corriger le formatage ».
Rédiger de la documentation hors ligne
Écrire de la documentation dans un avion ou dans une zone avec une connexion internet peu fiable ne signifie pas renoncer à voir votre formatage correctement rendu. Un outil d'aperçu local fonctionne de la même manière, connecté ou non.