md-links-mj v0.1.2
Índice
1. Definición del Proyecto
Md-links-mj es una libreria que lee y analiza archivos en formato markdown para verificar los links contenidos y reportar su estado (sin conexión, útiles o rotos) y dar algunas estadísticas que se imprimirán en consola como la cantidad de links, el estado de los links y el total de links únicos.
2. Instalación
Instalar previamente npm y Node.js en tu computador.
Para instalar la librería ejecuta el siguiente comando en la terminal:
$ npm i md-links-mj3. Uso de la libreria
En el archivo JS:
const mdlinks = require('md-links-mj'); En la terminal:
md-links <path-to-file> [options] Opciones:
Leer archivos con extensión .md
md-links <path-to-file.md> 
En este caso se obtiene como resultado:
- Nombre: Archivo o ruta donde fue encontrado el link.
- Titulo: Descripción del link.
- Enlace: Link encontrado.
--validate
Entrega la validacion o status de los links (status: 200, 404, 500 etc).
md-links <path-to-file.md> --validate 
--stats
Entrega las siguientes estadística: Total el total de links encontrados; Unique el total de links unicos.
md-links <path-to-file.md> --stats 
--stats --validate
Las dos opiciones combinadas, además de Total y Unique, agregan la siguiente estadística: Broken el total de links rotos;
md-links <path-to-file.md> --stats --validate || md-links <path-to-file.md> --validate --stats
4. Diagrama de Flujo
