itzaqui-md-links

Markdown Links

Índice

• 1. Librería md-links
• 2. Diagrama de flujo
• 3. Instalación
• 4. Guía de uso

---

1. Librería md-links

Markdown Links es una librería que extrae, analiza y valida los links que se encuentran en los archivos con formato .md.

2. Diagrama de flujo

Este proyecto se realizó siguiendo los pasos del siguiente diagrama:

3. Instalación

Para dar comienzo a la instalación de la librería , deberas contar con Node.js previamente instalado. Despues deberas copiar y ejecutar el siguiente comando en la terminal.

npm i itzaqui-md-links

4. Guía de uso

Para tener acceso al menú principal debe escribir md-links en la terminal.

md-links

Después debe escribir en la terminal el comando junto con el directorio que desea analizar. Al pasar la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona(ok) o no(fail).

md-links directorio o archivo.md --validate

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

md-links directorio o archivo.md --stats

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

md-links directorio o archivo.md --stats --validate