Md-links es una librería que le permitirá obtener información de los links que están presentes en sus archivos Markdown (.md). Es una librería que lee archivos md, busca los links y muestra información como la ruta en la que fué encontrado el link, su status http, entre otros.
Para instalar la librería deberá escribir el siguiente comando en la terminal:
npm i md-links-cotesaavedra
Una vez instalada ya puede comenzar a utilizarla.
Para utilizar la librería deberá escribir la siguiente línea de comandos:
md-links <path-to-file> --validate --stats
Donde:
md-links
: Hace referencia a la llamada de la librería
<path-to-file>
: Hace referencia a la ruta a un archivo o directorio de la que quiere obtener los links. (El archivo debe ser un .md, al no serlo no podrá ser leido).
--validate
: Un booleano. Este argumento puede estar presente (true) o no (false), nos proporciona información detallada de la url, como: status Http, ruta de la que proviene, entre otros.
--stats
: Un booleano. Este argumento puede estar presente (true) o no (false), nos proporciona estadísticas generales de todo el archivo/directorio leito, como número total de URLs encontradas, o links rotos.
Con validate:false
:
-
href
: URL encontrada. -
text
: Texto que aparecía dentro del link (<a>
). -
file
: Ruta del archivo donde se encontró el link.
Con validate:true
:
-
href
: URL encontrada. -
text
: Texto que aparecía dentro del link (<a>
). -
file
: Ruta del archivo donde se encontró el link. -
status
: Código de respuesta HTTP. -
ok
: Mensajefail
en caso de fallo uok
en caso de éxito.
mdLinks ./some/example.md
// => [{ href, text, file }, ...]
mdLinks ./some/example.md --validate
// => [{ href, text, file, status, ok }, ...]
mdLinks ./some/dir
// => [{ href, text, file }, ...]
Si pasa la opción --stats
el output (salida) será un texto con estadísticas básicas sobre los links.
$ md-links ./some/example.md --stats
Total: 3
Unique: 3
También puede combinar --stats
y --validate
para obtener estadísticas que necesiten de los resultados de la validación.
$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1