wendy-gs-md v1.0.0

Índice

• 1. Sobre el proyecto
• 2. Diagrama de flujo
• 3. Instalación
• 4. Uso
• 5. Contacto

1. Sobre el proyecto 🔍

Este módulo nos permite analizar todos los links que se encuentre en archivos de formato Markdown para porder verificar si son válidos o se encuentran rotos y reportar algunas estadísticas (total de links encontrados, total de links únicos y total de links rotos).

2. Diagrama de flujo ✍

3. Instalación 💻

npm install wendy-gs-md

4. Uso 🖱

Usaremos el comando md-links para ejecutar el programa

wendy-gs-md md-links <path> <options>

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio.
• options: No es obligatorio el ingreso de este valor, las opciones disponibles son :
  • --validate: Válida si los links estan funcionando.
  • --stats: Muestra el total de links y los links únicos.
  • --validate --stats: Muestra total de links, links únicos y total de links rotos .

✔ Muestra todos links encontrados de archivos .md

wendy-gs-md md-links <path>

Ejemplo

✔ --validate / -v : Muestra la validación de los links

wendy-gs-md md-links <path> --validate

Ejemplo

✔ --stats / -s : Muestra total de links y únicos

wendy-gs-md md-links <path> --stats

Ejemplo

✔ --stats --validate: Muestra total de links, únicos y rotos

wendy-gs-md md-links <path> --stats --validate

Ejemplo

✔ Si solo se ingresa el comando md-links saldrán las opciones de ayuda

wendy-gs-md md-links

✔ -h / --help: Muestra las opciones disponibles

wendy-gs-md md-links -h

5. Contacto 🙋

Wendy Gonzales

Project Link: https://github.com/wendy-gs/LIM013-fe-md-links