ro-li-md-links v0.1.0

Markdown Links

Índice

• 1. Preámbulo
• 2. Diagrama de Flujo
• 3. Backlog para la implementación de la librería
• 4. USO
• 5. Links de prueba
• 6. Autores

1. Preámbulo

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...), y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

Objetivo del proyecto

El programa funciona como una librería npm. El algoritmo realiza operaciones como: identificar ruta, convertirla en ruta absoluta, leer archivos, identificar y validar links. Es un programa que muestra lo que hay dentro de un 'archivo .md', tanto los enlaces válidos, como los enlaces con error.

2. Diagrama de Flujo

• A traves del diagrama de flujo se observa la lógica de la librería.

3. Backlog para la implementación de la librería

• Se creó en TRELLO la organización y planificación del mismo, haciendo uso de objetivo de aprendizaje (por sprint), listas para asignar tareas por funciones y dentro de cada una un checklist con tareas más pequeñas. También se encuentran links de aprendizajes sobre NODE.JS y librerías.

TRELLO

4. USO

• Para acceder se tiene que ingresar al sitio de npm y buscar "ro-li-md-links".

• Para instalar ingrese npm i ro-li-md-links.

• Copie el código que se encuentra en el archivo index.js.

• Para que ejecute ingrese en la terminal >> node nombre de carpeta ruta del archivo (donde están los archivos .md)

Ejemplo : node index.js ./README.md

Al "apretar enter" se imprimira un listado con el link del archivo , su texto y ruta.

Además de el estado del link

5. Links de prueba

BUENO

BUENO

MALO

MALO

6. Autores

• Linda Rizo
• Rosario Wrobel