Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.12 KB

README.md

File metadata and controls

65 lines (43 loc) · 2.12 KB

Markdown Links

Índice


1. Descripción

Markdown Links es una herramienta creada usando Node.js que lee y analiza archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

¿Por qué es importante?

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en diversas plataformas que manejan texto plano y es común encontrar varios archivos en este formato. Estos archivos Markdown Links normalmente contienen links (vínculos/ligas) que aveces están rotos o ya no son válidos lo que perjudica el valor de la información que se quiere compartir.

2. Instalación

Módulo instalable via npm install vaneah-md-links.Este módulo incluye un ejecutable que podamos invocar en la línea de comando e incluye una interfaz que puede importarse con require y usarlo programáticamente.

3. Uso

Para corroborar las opciones válidas podemos ejecutar en la terminal: md-links --help o md-links --h

--help:
help

El ejecutable de la aplicación se ejecuta de la siguiente manera a través de la terminal:

md-links <path-to-file> [options]

route md-links readmeExample.md route

--validate:
md-links readmeExample.md --validate --validate

--stats:
md-links readmeExample.md --stats --stats

--validate --stats:
md-links readmeExample.md --validate --stats --va--st

4. Diagrama de flujo

md-links