Aperçu Markdown

Tout l'attrait du Markdown est qu'il peut s'écrire et se lire comme du texte brut, mais cette même simplicité est précisément ce qui rend certaines erreurs invisibles jusqu'à leur rendu — un tableau auquel il manque un caractère de barre verticale dans sa ligne séparatrice retombe silencieusement en un paragraphe plat plutôt qu'un tableau, une liste imbriquée indentée avec le mauvais nombre d'espaces s'attache au mauvais élément parent, et il n'y a de message d'erreur pour aucun des deux problèmes, seulement une sortie qui silencieusement ne ressemble pas à ce qui était prévu. Voir le résultat rendu réel se mettre à jour continuellement pendant l'écriture détecte exactement ce genre d'erreur de formatage au moment où elle est introduite, ce qui est nettement plus rapide qu'écrire un README entier ou une description de pull request à l'aveugle et découvrir seulement après coup que le formatage s'est cassé une fois déjà publié quelque part.

GitHub, un site de documentation, et une publication de forum peuvent rendre la même source Markdown légèrement différemment sur des cas limites même en prenant tous largement en charge GFM, donc prévisualiser avant de publier vaut particulièrement la peine quand la destination est une où une erreur de rendu serait visible pour un large public — un README public, une annonce de sortie, ou une description de pull request que les relecteurs liront réellement avec attention.