Markdown Links Hunter es una librería que ayuda a los desarrolladores a analizar los enlaces existentes en un archivo con extensión ".md". La libreria incluye tanto una CLI para su uso en la terminal como una API que puedes utilizar desde cualquier archivo Javascript presente en la carpeta de tu proyecto.
Para instalar Markdown Links Hunter debes ejecutar el siguiente comando en la terminal:
npm install md-links-hunter
node md-links-hunter.js <ruta-de-archivo-md>
De forma predeterminada, Markdown Links Hunter recibe un único archivo .md, el cual analiza en busca de enlaces a sitios web externos. El resultado consiste en una lista de URLs y el texto asociado a cada uno:
node md-links-hunter.js <ruta-de-archivo-md> --validate o -v
Al espeficar este flag, Markdown Links Hunter realizará tanto el análisis básico como la validación de las URLs para conocer su código de estado (Ok 200, Fail 404, Warning para URLs no válidas) y mostrará la información de la siguiente manera:
node md-links-hunter.js <ruta-de-archivo-md> --stats o -s
Al espeficar este flag, Markdown Links Hunter realizará el análisis básico y entregará información estadística sobre las URLs existentes en el archivo .md. El resultado se verá de la siguiente manera:
node md-links-hunter.js <ruta-de-archivo-md> --validate --stats o -v -s
Al espeficar ambos flags, Markdown Links Hunter realizará el análisis básico, validará las URLs y mostrará información estadística sobre ellas. El resultado se verá de la siguiente manera:
Para utilizar la API de Markdown Links Hunter debes importar el módulo principal copiando y pegando la siguiente línea en el archivo javascript en el que quieras utilizarlo:
const mdLinks = require('md-links')
Luego, podrás utilizar el módula de esta forma:
mdLinks(<ruta-de-archivo-md>, *<opciones>)
<opciones> equivale a un objeto, el que puede contener las siguientes propiedades:
- Solo validación:
- Solo estadísticas:
- Tanto validación como estadísticas:
Para ejecutar un análisis básico, especifica únicamente la ruta
