md-links-ccvb v0.1.1

MDLinks

Markdown Links es una librería que examina y lee archivos en formato Markdown(.md), además de verificar los links que contenga el archivo .md, permitiendo así obtener un resumen del Total, Unique y Broken Links y el código de estado que se encuentra cada uno de ellos Click Aquí.

Instalación

Para utilizar esta librería, previamente deber tener instalado Node.js. Luego colocar el siguiente comando en su terminal.

  $ npm i md-links-ccvb

Uso

Podrá ejecutar la librería a través de la terminal. La rutas ingresadas pueden encontrarse en un directorio, ser un archivo, ser relativas o absolutas. Además va a recibir los siguientes comandos:

  --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, de lo contrario como fail; he aquí una muestra:

  --stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links; he aquí una muestra:

  --validate --stats || --stats --validate

Si pasamos ambas opciones --stats y --validate (o viceversa) se obtendrá estadísticas que necesiten de los resultados de la validación; he aquí uana muestra:

En caso no recuerde que colocar recibirá una ayuda en la propia terminal, solo debe colocar:

  mdLinks

La ayuda se mostrará de la siguiente manera:

Dependencias y Herramientas

• Node.js
• File System
• Path
• Chalk
• Node-Fetch
• Babel
• A guide to creating a NodeJS command-line package
• Tú, yo y package.json
• CommonJS vs ES Modules

Autora

• @Cinthia Velásquez