Los archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso puede complicar el uso de la información.
mdLinks es una herramienta de línea de comandos que te permite verificar y analizar enlaces en archivos Markdown.
Haciendo uso de Node.js se ha desarrollado una herramienta que nos permite analizar los links dentro de los archivos Markdown ya sea de un directorio o un archivo derectamente.
Esta librería está disponible de dos formas: como un módulo publicado en GitHub, que las usuarias podrán instalar e importar en otros proyectos, y como una interfaz de línea de comandos (CLI) que permitirá utilizar la librería directamente desde el terminal.
Para instalar mdLinks, ejecuta el siguiente comando en tu terminal:
npm install mdlinksmdlinks <Ruta-del-archivo-que-deseas-analizar> [--validate] [--stats]-
Despues de
mdLinkspasa la ruta del directorio o archivo que sera analizado. -
--validate: Opción para validar los enlaces encontrados (opcional). -
--stats: Opción para mostrar estadísticas sobre los enlaces (opcional).
- Analizar enlaces en un archivo Markdown:
mdlinks example.md
- Analizar enlaces en un directorio y validarlos:
mdlinks ./docs --validate
Analizar enlaces en un directorio, validarlos y mostrar estadísticas:
mdlinks ./docs --validate --stats
Para cada enlace encontrado, mdLinks mostrará el texto del enlace, la URL y el archivo en el que se encontró. Si se usa la opción --validate, mdLinks también mostrará el estado de validez de cada enlace.
Para este proyecto se ultilizo el siguiente Diagrama de Flujo.
