md-links-mcmacarena v0.9.0

Markdown Links

Índice

• 1. Introducción
• 2. Instalación
• 3. Dependencias
• 4. Uso en la terminal
• 5. Uso en la API

1. Introducción

Libreria que sirve para buscar y verificar todos los links que posea 1 o más archivos de extención "md". Entrega una lista con links, status y stats.

2. Instalación

npm i md-links-mcmacarena

3. Dependencias

Cuenta con 3 librerias para su funcionamiento

• fetch
• jsdom
• markdown-it

4. Uso en la terminal

Ejemplos de rutas a ingresar:

• md-links-mcmacarena ./path/path2: Devuelve todos los links de los archivos con extensión "md"
• md-links-mcmacarena ./path/file.md: Devuelve todos los links del archivo

HREF,TEXT,PATH.

md-links-mcmacarena <ruta (absoluta o relativa)>

VALIDATE.

md-links-mcmacarena <ruta (absoluta o relativa)> --validate
md-links-mcmacarena <ruta (absoluta o relativa)> --v

STATS.

md-links-mcmacarena <ruta (absoluta o relativa)> --stats
md-links-mcmacarena <ruta (absoluta o relativa)> --s

VALIDATE Y STATS.

md-links-mcmacarena <ruta (absoluta o relativa)> --validate --stats
md-links-mcmacarena <ruta (absoluta o relativa)> -- v --s

5. Uso en la API

const mdLinks= require("md-links-macarena/md-links)

HREF,TEXT,PATH.

mdLinks("ruta")

VALIDATE.

mdLinks("ruta","--validate")
mdLinks("ruta","--v")

STATS.

mdLinks("ruta","--stats")
mdLinks("ruta","--s")

VALIDATE Y STATS.

mdLinks("ruta","--validate","--stats")
mdLinks("ruta","--v","--s")