- 1. ¿Que es Md-Links?
- 2. Diagrama de Flujo
- 3. Instalación
- 4. Herramientas utilizadas de librería
- 5. Uso de la librería
- 6. Ejemplos de funcionalidad de la librería
Markdown Links es una librería de Node.js que nos permite buscar en un directorio todos los archivos en formato Markdown que en su interior contengan link y asi poder validar el estado actual de cada uno de ellos.
Para instalar la librería debes correr el siguiente comando:
La librería contiene las siguientes dependencias:
- Node.js
- File System
- Node-fetch
- Jsdom
- Markdown-it
- Chalk
- Figlet
Para hacer uso de la librería, debes importarla dentro de tu archivo principal de extensión .js de la siguiente manera:
Aparte del análisis básico del archivo, la librería ofrece 2 opciones o argumentos para entregar la validación y estadística de los links contenidos.
path
: El archivo .mdoptions
: Recibe un objeto con dos propiedades, "validate" y "stats".
La librería te ofrece la siguiente información:
- Nombre del archivo .md
- Total de links encontrados en el archivo.
- URL encontrada, el texto asociado al link y la ruta o file donde se encuentra el link.
- Lista de links con su url, status, el texto y archivo .md donde se encuentra.
- Total de links, total de links únicos y total de links rotos o no funcionales
Dependiendo de las opciones entregadas en la terminal, la librería ofrece diferentes datos de tus archivos .md.
Puedes hacer uso de esta libreria a traves de las siguientes instrucciones:
- Sin opciones: debes ejecutar la librería de la siguiente manera a traves de la terminal:
- Opción validate: ejecutar en la consola el siguiente comando:
options equivale a --validate o --v
- Opción stats: ejecutar en la consola el siguiente comando:
options equivale a --stats o --s
- Opción validate + stats: ejecutar en la consola el siguiente comando:
o
Este proyecto fue realizado por:
- 💻 Cindy Barria,
- 💻 Eliana Hidalgo,
- 💻 Paula Valdez