Markdown Links -

Índice

• 1. Descripción
• 2. Instalación
• 3. Instrucciones de uso

1. Descripción MD-links.

MD-links es una librería en Node.js que funciona como una herramienta para analizar links dentro de carpetas Markdown. Se encuentra disponible como módulo descargable de GitHub, el cual es posible instalar e importar dentro de otros repositorios, o puedes utilizarlo como una interfaz de línea de comandos (CLI), que te permitirá utilizarla desde la terminal. Esta librería contiene 3 archivos principales para su funcionamiento.

function.js : aquí se encuentran las funciones desarrolladas que permiten convertir rutas en absolutas, leer archivos, extraer links, validar links y además entregan una estadísticas.

index.js : en este archivo se desarrolla la función MD-links, que devuelve una promesa, unificando todas las funciones necesarias para analizar los archivos Markdown.

CLI.js: esta es la interfaz de línea de comando, que permite interactuar con los argumentos proporcionados por la usuaria, que se ejecutan desde la terminal.

2. Instalación MD-links.

Puedes instalarlo directamente desde GitHub con el siguiente comando

                   npm install Carolinava21/md-links

3. Instrucciones de uso.

• Para poder leer un archivo markdown y extraer sus enlaces , se debe ejecutar el comando md-links junto con el nombre del archivo Markdown que quieras verificar

                           md-links archivo.md

• Para verificar el estado de cada uno de los links extraídos y recibir una respuesta http.

                        md-links archivo.md --validate

• Para obtener un estadistica del archivo analizado.

                         md-links archivo.md --stats

• Para mostrar la estadísticas básicas y los enlaces rotos en un archivo Markdown

                         md-links archivo.md --validate --stats