Es natural que ahora todo desarrollador de software dedique tiempo a crear cualquier nivel de documentación. Desde un archivo README.md que explique rápidamente lo que el proyecto hace hasta una documentación sana y elegante. Como sea dominar la capacidad de crear documentos buenos de markdown es una habilidad que puede ser muy útil.
Una de las debilidades de trabajar con archivos markdown es que sin quererlo podríamos caer en la posibilidad de que cada quien edite los archivos de muchas formas diferentes cayendo incluso sin quererlo en errores dentro de los archivos.
La solución es sencilla, una extensión de VS Code llamada Markdownlimit.
Una vez instalada la extensión, comenzará a analizar tus archivos markdown y encontrar las mejoras que puedes agregar en tus archivos. ¿Quieres algunos ejemplos? Intenta utilizar un ejemplo como el siguiente.
Si escribes esto en un markdown podrás tener un arbol muy parecido a lo siguiente.
Todo normal ¿no es así? Bueno, pues resulta que la mejor opción para esto es modifocar la sintaxis de acuerdo a como sea sugerido por la extensión.
El primer cambio sugerido es utilizar asteriscos en lugar de guiones. El segundo cambio es utilizar espacios dobles en lugar de tabuladores.
Durante la aparición de cada incidencia, puedes también seleccionar un enlace que aparece que te redirecciona a un repositorio de Github donde podrás encontrar todas las reglas que puedes seguir para tener un documento perfecto. Si seguimos con la observación anterior, podremos encontrar una regla para esa situación.
Gracias a esta extensión parece que será buena idea cometer muchos errores para aprender rápido. Hay muy buenos trucos que puedes aprender y te servirán para mejorar mucho en la redacción de tus documentos.
¡Disfruta tu nueva extensión!