md-links-jersabell v0.1.0

Markdown Links

Índice

• 1. Markdown Links
• 2. Instalación
• 3. Uso
• 4. Herramientas y Librerias Utilizadas
• 5. Autor

1. Markdown Links

¿Qué es Markdown Links? 🔗

Es una librería que analiza archivos en formato Markdown (.md) y verifica si contiene links. De ser así, muestra su estado 200 (ok), 404 (fail) o status no encontrado (fatal error). También cuenta el total de links, los que son únicos y los que están rotos.

🇲🇩 Aquí link de acceso al package de npm.

2. Instalación ⚙️

Para utilizar Markdown Links debes tener instalado Node.js de forma previa. Luego debes ejecutar el siguiente comando en la terminal:

$ npm install md-links-jersabell

3. Uso 💻

Cuando quieres ver los links que contienen tus archivos .md tienes que ejecutar el siguiente comando en la terminal:

$ md-links [path] [options]

• path: es la ruta absoluta o relativa del archivo o directorio.
• options: son comandos que le puedes agregar para que haga distintas tareas. Por ejemplo:

$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

Options:

--validate

Si pasamos la opción --validate, el módulo hará la petición HTTP para averiguar si el link funciona o no. Ejemplo:

$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google

--stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links. Ejemplo:

$ md-links ./some/example.md --stats
Total: 3
Unique: 3

También puedes combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación. Ejemplo:

$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1

4. Herramientas y Librerias Utilizadas 🛠️

• Git y GitHub – Para el repositorio e issues.
• Node – Para el entorno de ejecución de JavaScript.
• Cross Fetch – Para hacer la petición HTTP de los links/urls.
• Chalk – Para colorear y destacar los resultados de la ejecución.

5. Autor ⭐

• Jersabell Tineo - Front-end Developer.