md-links-yumi

Markdown Links :)

Índice

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Instalación
• 4. Arquitectura

1. Preámbulo

El Markdown es un lenguaje de marcado ligero ampliamente reconocido y utilizado por desarrolladores. Se emplea en numerosas plataformas que manejan texto plano, como GitHub, blogs, etc. Es común encontrar varios archivos en este formato en diversos repositorios, siendo el README.md el más destacado y utilizado como punto de partida.

Estos archivos Markdown suelen contener enlaces que, lamentablemente, a menudo se rompen por diversos motivos. Cuando estos enlaces dejan de funcionar, se perjudica considerablemente el valor de la información que se desea compartir en un README. La incapacidad de acceder a los recursos vinculados dificulta la comprensión completa del contenido y puede generar frustración en los lectores.

2. Resumen del proyecto

Esta librería aborda el problema de los enlaces rotos en archivos Markdown mediante el desarrollo de un algoritmo especializado que permite buscar y analizar los enlaces con comandos específicos. Proporciona información valiosa sobre la cantidad total de enlaces, la cantidad de enlaces rotos y la presencia de enlaces repetidos. Con esta herramienta, podrás identificar y solucionar fácilmente los enlaces rotos, garantizando la calidad de la información compartida en tus archivos Markdown.

3. Instalación

npm i md-links-yumi

Guía de instrucciones

A través de tu terminal de Git, podras acceder a los resultados con las siguientes instrucciones de CLI:

 mdLinks <path-to-file>

• md-links comando iniciar el funcionamiento.
• <path-to-file-or-directory> ruta del archivo o directorio.

 mdLinks <path-to-file> --validate:

$ md-links ./some/example.md --stats
{ Total: 3, Unique: 3 }

$ mdLinks ./some/example.md --stats --validate
{ Total: 3, Unique: 3, Broken: 2 }

4. Arquitectura

Boilerplate

./
├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── README.md
├── package.json
├── src
│   ├── api ── ├──index.js
|   |          └── utils ──├── file.js
|   |                      ├── markdown.js
|   |                      └── truncate.js                   
│   ├── cli ── ├──cli.js
|   |          └── utils ── stats.js
|   |
│   ├── client ── client.js
│   └── img
└── test
    └── index.spec.js

Diagrama de flujo