md-links-arelizoyarce
v0.1.2
Published
md-links is a framework to find links in md files
Readme
Proyect Md-Links 🔗
Qué es Md-Links ❓
Md-links es un framework de Javascript que te permite reconocer URLs dentro de una archivo Markdown,
validarlas mediante un llamado HTTP y obtener información estadistica de estos: estado de enlace,
enlaces totales en un archivo, enlaces únicos y enlaces rotos. Válido para carpetas o documentos.
Manual de uso
Instalación ⬇️
El framework es instalable a través de npm i md-links-arelizoyarce
Funcionamiento
Luego de haber instalado el framework, este sería ejecutable a través de md-links <nombre del archivo>
o md-links <nombre del archivo> <option>.
Las posibles opciones a ejecutar son:
--validate
--stats
--validate --stats o --stats --validate
Ejecución
1.
Al colocar en la consola unicamente el nombre del archivo, te mostrará los links, la ruta de cada uno y
el texto que los envuelve.
2.
Si implementa la opción --validate se validará cada link dentro del archivo, mostrando su estado y un mensaje de
aprobación o negación.
3.
Si implementa la opción --stats se mostrará el total de links que hay en un archivo y cuántos de estos son únicos.
4.
si implementa la opción --validate --stats se mostraran los links totales y únicos dentro del archivo y cuántos links
están rotos
