Md-links-paotg NPM

Markdown Links

La librería 'Markdown-Links'sirve para detectar los links que contiene un archivo con extensión .md, y hace cálculos estadísticos con respecto al total, unique y los links broken.

🔗Diagramas de Flujo

API CLI

🔗Instalación

🧩 Global

npm install -g git://github.com/paotovar/LIM014-mdlinks

🧩 Local

npm install git://github.com/paotovar/LIM014-mdlinks

🔗Para usarlo

🧩 JAVASCRIPT API

mdLinks("./some/example.md") .then(links => { // => { href, text, file } }) .catch(console.error);

mdLinks("./some/example.md", { validate: true }) .then(links => { // => { href, text, file, status, ok } }) .catch(console.error);

mdLinks("./some/dir") .then(links => { // => { href, text, file } }) .catch(console.error);

🧩 Através de línea de comandos (CLI)

mdLinks options

Instrucciones ⚠️mdLinks < path-to-file > ⚠️mdLinks < path-to-file > --validate ⚠️mdLinks < path-to-file > --stats ⚠️mdLinks < path-to-file > --stats --validate

Por ejemplo:

🧩 Sin options:

$ mdLinks './test/fileTest/README.md'

◾️HREF: https://nodejs.org/es/ ◾️TEXT: Este es el link ◾PATH: C:/Users/pc/Desktop/TERCER PROYECTO/LIM014-mdlinks/test/fileTest/README.md

◾️HREF: https://www.laboratoriaaaaa.la/ ◾️TEXT: Este es el link no existe ◾PATH: C:/Users/pc/Desktop/TERCER PROYECTO/LIM014-mdlinks/test/fileTest/README.md

◾️HREF: https://www.npmjs.com/package/123456789 ◾️TEXT: 404 ◾PATH: C:/Users/pc/Desktop/TERCER PROYECTO/LIM014-mdlinks/test/fileTest/README.md

🧩 --validate || --v || --V

$ mdLinks './test/fileTest/README.md' --validate HREF: https://nodejs.org/es/ TEXT: Este es el link PATH: C:/Users/pc/Desktop/TERCER PROYECTO/LIM014-mdlinks/test/fileTest/README.md STATUS: 200 STATUSTEXT: OK

HREF: https://www.laboratoriaaaaa.la/ TEXT: Este es el link no existe PATH: C:/Users/pc/Desktop/TERCER PROYECTO/LIM014-mdlinks/test/fileTest/README.md STATUS: STATUSTEXT: Este link no existe

HREF: https://www.npmjs.com/package/123456789 TEXT: 404 PATH: C:/Users/pc/Desktop/TERCER PROYECTO/LIM014-mdlinks/test/fileTest/README.md STATUS: 404 STATUSTEXT: Fail