md-links-ximena v1.0.0

Markdown Links

1. Introducción

MD-Links Es una librería que permite leer los archivos Markdown(.md) en busca sus links, en esta librería se puede obtener la estadística del estados de los links como links totales, únicos y rotos.

2.Instrucciones de uso

Las siguientes instrucciones le permitirán instalar la biblioteca en su terminal.

2.1 Instalación

La instalación se puede realizar por npm:

$ npm i mdLinks-xsilvac

2.2 Interfaz de Linea de Comando (CLI) ⚙️

Se ejecuta de la siguiente manera a través del terminal:

$ mdLinks <path> [options]

Ejemplo:

$ mdLinks <path>

2.2.1 Opciones

--validate Al pasar la opción '--validate', el módulo hará una petición HTTP para averiguar si el link se encuentra activo o no; si el link se encuentra activo responde "OK" y se considerara una URL valida, pero si un link no esta activo devolverá como mensaje "FAIL".

$ mdLinks <path> --validate

--stats Si pasamos la opción --stats nos retornara las estadísticas de los links totales y únicos.

$ mdLinks <path> --stats

--validate --stats Si pasamos la opción --validate y --stats nos retornara las estadísticas de los links totales, únicos y rotos.

$ mdLinks <path> --validate --stats

--stats --validate Si pasamos la opción --stats y --validate nos retornara las estadísticas de los links totales, únicos y rotos.

$ mdLinks <path> --stats --validate

--help Si pasamos la opción --help nos retornara un cuadro con la explicación de esta libreria.

$ mdLinks <path> --help

3. Proceso de desarrollo:

La planeación se realizó a través de un flujograma que demuestra el proceso de la creación de esta libreria.

4. Liberías empleadas 📚

• File-Sytem
• Path module
• Node-fetch
• chalk
• jest

Author ✒️

Ximena Silva Cotrina