Markdown Links

Índice

• 1. Preámbulo
• 2. Acerca de este proyecto
• 3. Diagrama de flujo
• 4. Instalación
• 5. Comandos
• 6. Errores

---

1. Preámbulo

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...) y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

2. Acerca de este proyecto

md-links es una librería desarrollada usando Nodejs que permite leer y analizar archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

3. Diagrama de flujo

Se elaboró un diagrama de flujo para organizar la ruta de desarrollo de este proyecto.

4. Instalación

Esta librería es instalable vía npm install https://github.com/Caro-V/DEV001-md-links.git

5. Comandos

El ejecutable de esta aplicación se puede ejecutar de la siguiente manera a través de la terminal: md-links <path-to-file> [options]

• Si solo se ingresa md-links, recibimos un mensaje de bienvenida y la información detallada acerca de los comandos

md-links

• Si se ingresa md-links <path-to-file>, no se valida si las URLs responden ok o no, solo identifica el archivo markdown (a partir de la ruta que recibe como argumento), analiza el archivo Markdown e imprime los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link.

md-links prueba/EXTRA.md 

• Si se ingresa md-links <path-to-file> --validate, el módulo hace 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.

md-links prueba/EXTRA.md --validate

• Si se ingresa md-links <path-to-file> --stats, el output (salida) será un texto con estadísticas básicas sobre los links.

md-links prueba/EXTRA.md --stats

• Si se ingresa md-links <path-to-file> --stats --validate o md-links <path-to-file> --validate --stats , obtendremos estadísticas que necesiten de los resultados de la validación.

md-links prueba/EXTRA.md --validate --stats

6. Errores

• Al ingresar un path que no existe

• Al ingresar un path que no es un archivo

• Al ingresar un path que no es un archivo con extensión .md

• Cuando se identifica que el archivo .md ingresado no contiene links