Markdown Links 📂📌📚

Índice

• 1. Descripción
• 3. Flujogramas de desarrollo
• 3. Instalación
• 4. Modo de Uso
• 5. Checklist
• 6. Fuente
• 7. Autores

---

1. Descripción

Markdown Links 📁 es una libreria que te permitira leer y analizar los archivos 📑 en formato Markdown, se podra realizar inspección de los links que contengan y vaalidar si funcionan o ya no.

Tambien brinda estadisticas del total de links encontrados, los unicos y los rotos en cada archivo 📊.

---

2. Flujogramas de desarrollo

2.1 Desarrollo de API 📋

2.2 Desarrollo de CLI (Command Line Interface - Interfaz de Línea de Comando) 📋

---

3. Instalación ✅

Para instalar la librería md-links, se necesitará escribir el siguiente comando en la terminal.

npm i npm i md-links-merly

---

4. Modo de uso 🖥

Para usar la libreria se hara uso de la terminal bash o cmd

Comando CLI ✅

Ejecutar el comando:

$ md-links

• Despues de ello le pedira que coloque una ruta, esta puede ser relativa o absoluta
• Elegir una opción (--nothing, --validate, -- stats, --validate --stats)

📚 Opciones:

❓ --help:

Brinda informacion sobre las acciones de las opciones.

✏️ --nothing:

Muestra una informacion basica de los archivos.

✏️ --validate:

Muestra información general por cada enlace encontrada, ademas de ello analiza el estado de los links que contiene el archivo ".md".

✏️ --stats:

Brinda información acerca del número total de links y links únicos que se encuentran en el ruta que se ha analizado.

✏️ --validate --stats:

Brinda información acerca del número total de links, links únicos y links rotos que se encuentran en el ruta que se ha analizado.

---

5. Tests 📊

6. Checklist

General

API mdLinks(path, opts)

• ✅ El módulo exporta una función con la interfaz (API) esperada.
• ✅ Implementa soporte para archivo individual
• ✅ Implementa soporte para directorios
• ✅ Implementa options.validate

CLI

• ✅ Expone ejecutable md-links en el path (configurado en package.json)
• ✅ Se ejecuta sin errores / output esperado
• ✅ Implementa --validate
• ✅ Implementa --stats

Pruebas / tests

• ✅ Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
• ✅ Pasa tests (y linters) (npm test).

---

6. Fuente

Markdown Links del Repositorio de Laboratoria

---

7. Autora

• Merly Anco

---