md-links-kvasquez
v0.1.0
Published
libreria para buscar links, verificar el estado de validez y obtener estadisticas de archivos tipo Markdown
Downloads
5
Readme
[MD-LINKS] Es una libreria de NodeJS que permite analizar los archivos de tipo
Markdown
, ya sea desde un archivo o directorio, que pueden estar alojados dentro
de carpetas .
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.
Diagrama de Flujo
Instalar
npm install md-links-kvasquez
Version
0.1.0
Comando CLI
Guia
Si el usuario no ingresa ninguna url se mostrará el mensaje indicando el error.
Si se solicita ayuda se puede ingresar la opcion --help
, el cual le detallará las opciones.
Si se ingresa una ruta que no existe se mostrará el siguiente mensaje
Options
--validate
Si pasamos la opción --validate
, el módulo debe hacer una petición HTTP para
averiguar si el link funciona o no. Si el link resulta en una redirección a una
URL que responde ok, entonces consideraremos el link como ok.
--stats
Si pasamos la opción --stats
el output (salida) será un texto con estadísticas
básicas sobre los links.
--validate stats
También podemos combinar --stats
y --validate
para obtener estadísticas que
necesiten de los resultados de la validación.