/cqg-02

Primary LanguageJavaScript

md-links

Descripción

Markdown links es una biblioteca para examinar archivos tipo markdown, a través de rutas ingresadas a través de la línea de comando (CLI), las cuales pueden ser archivos unitarios o directorios que contengan archivos con extensión '.md'. Esta nos permite obtener reportes estadísticos de los enlaces encontrados, información sobre el estado de los links a través de peticiones HTTP, así como datos generales.

Diagrama de Flujo

Diagrama de Fujo

Instalación

Para instalar la biblioteca debe ejecutar el siguiente comando:

npm md-links-ory-chacon -g

Guía de uso

Para ejecutar la línea de comandos en la terminal debe utilizar:

md-links [options]

Para visualizar la tabla de ayuda utilice la opción --help o -h luego de una ruta, o ingrese md-links sin ruta ni opciones.

help

Para verificar la versión instalada ingrese la opción --version o -v.

version

Para verificar el status HTTP a través de una consulta fetch, ingresar la opción --validate o -va. Se mostrará el href, status HTTP, Ok o Fail, text.

validate

Para verificar los stats de los enlaces (totales y únicos) ingresar la opción --stats o -s.

stats

Para verificar los stats de los enlaces (totales, únicos y rotos) ingresar las opciones --validate o -va y --stats o -s (cualquier convinación de validate y stats es válida).

validate-and-stats

En caso de ingresar md-lins con una ruta pero sin opciones validate o stats se mostrará el href, text, y ruta de cada enlace

default

Si la ruta ingresada no existe: "LA RUTA NO EXISTE".

Si la ruta no contiene enlaces:

Caso Validate:

default