alidacontreras-mdlinks v1.0.0

Markdown Links

Esta es una libreria que permite visualizar el nombre, la direccion y el estado de los links de un archivo de formato MD.

Versión

1.0.0

Homepage

GitHub Alida Contreras

Instalación

npm install --global AlidaContreras/mdLinks

Guía de uso

md-links <path> <options>

• path : es la ruta de la carpeta o archivo.
• option :
  • --v o --validate : estas opciones validan si el link esta activo o no.
  • --s o --stats : estas opciones muestran estadisticas de los links(activos, rotos y unicos) Se puede combinar las dos opciones y mostrara la cantidad de links que hay, cuantos estan rotos y cuantos son unicos.

CLI (Línea de comandos)

md-links <path> <options>

Por ejemplo: Retorna las propiedades file, href y text

$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

Retorna las propiedades file, href, text, status y value

$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google

Retorna las propiedades total(cantidad total de links) y unique(cantidad de links unicos)

$ md-links ./some/example.md --stats
Total: 3
Unique: 3

Retorna las propiedades total(cantidad total de links) y unique(cantidad de links unicos) y broken cantidad de links inactivos)

$ md-links ./some/example.md --s --v
Total: 3
Unique: 3
Broken: 1