nadiachayna / LIM015-md-links

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

✨ md-links-cats

Es la librería, en la cual su función va es validar las rutas o llamadas URL que estén dentro de archivos o directorios Markdown en donde podremos verificar si los links se encuentran rotos y/o no estén válidos, el status de los links, links únicos, links rotos y el total de estos.


Instalación

Se puede instalar por npm:

$ npm i md-links-cats

Guía de uso

Se logra ejecutar la librería por medio de la terminal:

md-links-cats <path-to-file> [options]

Las rutas ingresadas pueden ser relativa o absoluta y las opciones son: --stats, --validate, o usar las dos juntas --stats --validate, --validate --stats.

Ingresando la ruta absoluta o relativa:

  • Se obtiene la ruta absoluta, los links y el texto.

pic1

Agregando las opciones:

  • Ingresamos --validate, se obtiene la ruta relativa, el link, el texto del link y el estatus.

pic2

  • Ingresamos --stats, se obtiene el total de links y los links únicos.

pic3

  • Ingresando los dos, --stats --validate (o al revés), se obtiene el total de links, los links únicos y los rotos.

pic4

Si necesitas ayuda:

Si no recuerdas las opciones, puedes colocar --help.

pic5

Si hay algún error:

pic6

Si el archivo está vacío:

pic7


Diagramas

DIAGRAMA API y CLI


About


Languages

Language:JavaScript 100.0%