Markdown Links

Índice

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Objetivos de aprendizaje
• 4. Comandos

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.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2. Resumen del proyecto

mdLinks es una libreria creada con NodeJS que permite verificar el estado de los enlaces que se encuentran en un archivo Markdown.

Esta biblioteca es útil para verificar si algunos de nuestros enlaces están repetidos, rotos o son inválidos.

3. Instalación

npm i md-maria-links

4. Comandos

Para empezar a validar el path se inicia de la siguiente manera:

start-md-Links <path>

Menú de ayuda

Para ver el menú de ayuda se debe ingresar start-md-Links --help o start-md-Links --h allí se verán todos las opciones disponibles

Opciones

Al incertar la ruta a validar: start-md-Links ./path-a-evaluar.md nos mostrará las siguientes propiedas de cada link encontrado

Al ingresar el comando start-md-Links <path> --validate o start-md-Links <path> --v se validará si el link funciona o no, como se muestra a continuación:

Con la opción start-md-Links --stats o start-md-Links <path> --s obtendremos las estadísticas básicas sobre los links, como el número total de links y links únicos

Por último la opción combinada de start-md-Links <path> --stats --validate o start-md-Links <path> --s --v Obtendrás las estadísticas de los enlaces rotos