@bellasacc/md-links

libreria links markdown

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Sep 3, 2018Aug 13, 2018Minified + gzip package size for @bellasacc/md-links in KB

Readme

Markdown Links

Libreria para verificar el status de los links que coloque en sus archivos de tipo markdown, para realizar dicha acción deberá escribir en la linea de comando (CLI) de su terminal una ruta y la opción --validate, este hará una petición HTTP con fetch, devolviendo una respuesta a cada petición realizada. También puedes obtener las estadísticas de los links validos, rotos y la cantidad total de links existentes.

Instalar

npm i @bellasacc/md-links

Comandos CLI

md-links <path-file-or-dir> [options]

<path-file-or-dir> ruta de un archivo o de un directorio.

[options] : las opciones son las siguientes:

  • --validate : con esta opción se hace la petición HTTP.

  • --stats : aquí obtendremos estadísticas de los links encontrados, como el total y los links unicos.

  • --validate --stats: este devuelve estadísticas mas completas con el total, unicos y links rotos.

Versión

0.1.1

Ejemplo

Instalando paquete ... intalación

Ahora le pasamos una ruta de un archivo markdown en el CLI

md-links <path-file-or-dir>

$ md-links ./carpeta/README.md

path

--validate

Aquí le enviaremos la opción --validate, escribe la ruta y la opción mencionada.

md-links <path-file-or-dir> --validate

$ md-links ./carpeta/README.md --validate

validate

--stats

Aquí le pasaremos la opción --stats, escribe la ruta y la opción mencionada.

md-links <path-file-or-dir> --stats

$ md-links ./carpeta/README.md --stats

validate

--validate --stats

También podemos combinar ambas opciones y tendremos estadísticas junta con la respuesta HTTP.

md-links <path-file-or-dir> --validate --stats

Ahora escribe la ruta y las opciones mencionadas, nos mostrará el total de links, los unicos y los rotos.

$ md-links ./carpeta/README.md --stats --validate

validate

Backlog de implementación del proyecto

Test: pruebas unitarias

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.