vaneah-md-links v0.1.1
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:
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
--validate:md-links readmeExample.md --validate
--stats:md-links readmeExample.md --stats
--validate --stats:md-links readmeExample.md --validate --stats
4. Diagrama de flujo
