mdlinks-checker

mdlinks-checker

Es una librería que permite validar las URLs que se encuentran dentro de archivos con lenguaje markdown. Esta te permitirá obtener: status de los links, total de links, links únicos y links rotos.

Este proyecto fue creado para el Bootcamp de Laboratoria - Lima 015 💛

---

Instalación

Puedes instalarlo por npm:

$ npm i mdlinks-checker

Guía de uso

Puedes ejecutar la librería a través de la terminal:

mdlinks-examiner <path-to-file> [options]

Las rutas ingresadas pueden ser relativas o absolutas y las opciones que puedes usar son: --stats, --validate, o usar las dos juntas --stats --validate.

Path to file	Options
./file/file.md	--stats
C:\user\file	--validate

Usando una ruta:

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

Usando las opciones:

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

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

• Usando los dos, --stats --validate (sin importar el orden), se obtiene el total de links, los links únicos y los rotos.

Si necesitas ayuda:

Si no recuerdas las opciones, puedes colocar --help para volver a chequear las opciones.

---

Diagramas

DIAGRAMA API y DIAGRAMA CLI