md-links.francy

MDLinks Librería

Índice

• 1. Descripción de la libreria
• 2. Instalación
• 3. Guía de uso
• 4. Desarrollo de la librería
• 5. Creadora

---

1. Descripción de la librería

Esta librería busca principalmente apoyar los proyectos, en la lectura e identificación de archivos markdown, y dentro de ellos validar el código de estado de los links o urls existentes.

2. Instalación

Para la instalación de la librería se debe digitar el siguiente comando a través de la terminal de su editor de código, desde la terminal de Git Bash.

npm i md-links.francy

3. Guía de uso

Para usar la librería, posterior a la instalación e importación de la misma, existen 2 formas de ejecutarlo.

Options:

• [ ] ' ' no ingresa ninguna opción, de esta manera la función no realiza validación, por lo cual imprime solo el texto del link encontrado, ubicación del archivo y url. Retorna un objeto como el siguiente:

• [ ] '--validate' || '--v' le solicita a la función realizar la validación de los links encontrados, por lo cual imprime el texto del link encontrado, ubicación del archivo, url, código de estado, y ok. Retorna un objeto como el siguiente:

• [ ] '--stats' || '--s' le solicita a la función realizar imprimir las estadísticas, por lo cual imprime Total de links encontrados, y cantidad de links no repetidos. Retorna un objeto como el siguiente:

• [ ] '--stats' && '--validate' le solicita a la función realizar las estadísticas y la validación, por lo cual imprime Total de links encontrados, cantidad de links no repetidos, y cuantos links rotos se encontrarón. Retorna un objeto como el siguiente:

Ejecución:

El usuario debe ingresar la ruta ya sea relativa o absoluta entre comillas

• [ ] Desde la la terminal de Git Bash se debe ejecutar el comando mdLinks <'ruta del archivo o diredtorio a examinar'> <options>

Desarrollo de la librería

Para el desarrollo del proyecto se estableció una ruta de trabajo, a través de un flujograma de procesos, el cual se puede observar a continuación.

Flujograma de trabajo - MDLinks

Creadora

Francy Milena Corredor Ramírez

Estudiante Laboratoria

Cohort BOG-004

GitHub: https://github.com/FRANCY15