md-links-minder v1.0.1
Markdown Links
Índice
1. Preámbulo
Markdown es un lenguaje de marcado
ligero muy popular entre developers. Es usado en muchísimas plataformas que
manejan texto plano (GitHub, foros, blogs, ...) y es muy común
encontrar varios archivos en ese formato en cualquier tipo de repositorio
(empezando por el tradicional README.md).
Estos archivos Markdown normalmente contienen links (vínculos/ligas) que
muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de
la información que se quiere compartir.
Dentro de una comunidad de código abierto, nos han propuesto crear una
herramienta usando Node.js, que lea y analice archivos
en formato Markdown, para verificar los links que contengan y reportar
algunas estadísticas.
2. Resumen del proyecto
mdLinks es una libreria creada con NodeJS que permite verificar el estado de los enlaces que se encuentran en un archivo Markdown.
Esta biblioteca es útil para verificar si algunos de nuestros enlaces están repetidos, rotos o son inválidos.
3. Instalación
$ npm i md-links-minder4. Comandos
Accede a la terminal y ejecuta el comando
$ md-links --helpTe mostrará las instrucciones para seguir y podrás conocer todas las opciones y argumentos disponibles para utilizar la herramienta.
Ejemplo
$ md-links --help
El segundo paso es incertar la ruta a validar: md-links ./path-a-evaluar.md
Sólo colocando la ruta obtendremos un arreglo de objetos con las propiedades:
Href: URL encontrada.
: Texto que aparecía dentro del link ().
File: Ruta del archivo donde se encontró el link.
Ejemplo
Opciones
Comando --Validate
$ md-links <path> --validateObtendrás el estado de los enlaces de tus archivos
Ejemplo
Comando --stats
$ md-links <path> --statsObtendrás las estadísticas del total de enlaces y los enlaces únicos
Ejemplo
Comando --validate --stats
$ md-links <path> --validate --statsObtendrás las estadísticas de los enlaces rotos
Ejemplo
Asegurese de ingresar una ruta valida que contenga archivos tipo Markadown