Escribes un README con viñetas anidadas, un par de bloques de código y una tabla comparando dos enfoques. Se ve bien como texto plano en tu editor. Luego lo subes a GitHub y la tabla está desalineada, uno de tus bloques de código no se cerró correctamente, y una lista numerada se reinició en 1 a mitad de camino por una línea en blanco perdida. Ahora estás subiendo pequeños commits de corrección solo para que el formato quede bien.
Markdown es lo bastante sencillo como para escribirlo de memoria con formato básico, pero las tablas, las listas anidadas y los bloques de código tienen pequeñas peculiaridades de sintaxis que difieren ligeramente entre renderizadores. GitHub Flavored Markdown no es idéntico a CommonMark, que no es idéntico a lo que use tu generador de sitios estáticos. La brecha entre "se ve bien en mi cabeza" y "se renderiza bien en la página" es exactamente donde una vista previa en vivo demuestra su valor.
Por qué hacer commit para comprobar es un mal flujo de trabajo
Subir un commit solo para ver cómo se renderiza un README, luego otro para arreglar una tabla rota, luego otro para arreglar la corrección, llena tu historial de commits con ruido de formato que no tiene nada que ver con el contenido real. También significa que cada ciclo de vista previa tarda lo que un push y una recarga de página — lo bastante lento como para que dejes de molestarte en comprobar y simplemente esperes que se vea bien.
Ve la salida renderizada mientras escribes
Bellows incluye una herramienta de vista previa de Markdown que renderiza la salida formateada mientras pegas o escribes Markdown sin formato. Encabezados, listas, tablas, enlaces y bloques de código se renderizan inmediatamente, para que puedas detectar errores de formato antes de que terminen en un commit.
Escribir READMEs y descripciones de PRs
Las descripciones de pull requests y los archivos README son a menudo lo primero que lee un revisor o un nuevo colaborador. Comprobar que los encabezados, las listas de verificación y las imágenes enlazadas se renderizan correctamente antes de enviar ahorra una ronda de comentarios de "¿puedes arreglar el formato?".
Redactar documentación sin conexión
Escribir documentación en un vuelo o en una zona con internet inestable no significa renunciar a ver tu formato renderizado correctamente. Una herramienta de vista previa local funciona igual estés conectado o no.