Markdown Links

Índice

• 1. Resumen
• 2. Planning
• 3. Diagramas de flujo
• 4. Modo de uso

---

1. Resumen

Markdown links es una herramienta de línea de comando (CLI) y propia librería (o biblioteca - library) en JavaScript para detectar links rotos. Al instalar este módulo serás capaz de detectar el status de tus links en archivos .md además de validar estos mismos.

2. Planning

Planning en github, usando milestones e issues.

Estas fueron las Tareas a realizar:

3. Diagramas de flujo

Para empezar este proyecto se realizaron dos diagramas de flujo para así poder tener trazados los pasos a seguir. Uno para la api y el otro para la línea de comando.

4. Modo de uso

Instalación

Se puede instalar usando npm install solsepulveda/DEV004-md-links

Comandos:

md-links

md-links --help

Con este comando puedes visualizar todas las opciones que puedes utilizar.

por ejemplo:

md-links

Con este comando puedes visualizar text, href y file.

por ejemplo:

md-links ./ejercicios/archivo.md

md-links --stats

por ejemplo:

md-links ./ejercicios/archivo.md --stats

md-links --validate

por ejemplo:

    md-links ./ejercicios/archivo.md --validate

md-links --stats --validate ó md-links --validate --stats

por ejemplo:

md-links ./ejercicios/archivo.md --validate --stats