yennjp-md-links
v1.1.1
Published
Markdown links
Downloads
11
Readme
Author Yennyfer Jarava Pérez
Índice
1. Sobre el proyecto
Nuestra librería, impulsada por Node.js, no solo tiene la habilidad de detectar enlaces quebrados, sino que también le brinda estadísticas claras y concisas, permitiéndole tomar decisiones informadas sobre la integridad de sus enlaces. ¡Es como contar con su propio guardián personal de enlaces!
No deje que los enlaces rotos obstaculicen su trabajo. Únase a nosotros y descubra cómo nuestra librería puede elevar su experiencia en Markdown a niveles sin igual. ¡Es hora de tomar el control de la calidad de sus enlaces y destacar en la comunidad de código abierto! ⚡️ No pierda esta oportunidad.
Lenguaje de programación
2. Instalación
npm i yennjp-md-links
3. Uso
md-links <path> [options]
Donde <path>
corresponde a la ruta, ya sea absoluta o relativa, del archivo o directorio que deseas analizar y [options]
ofrece la flexibilidad de personalizar la salida según tus necesidades.
Options:
--validate o --v
Si optas por incluir esta opción --validate o --v
, el paquete realizará una solicitud HTTP para verificar la validez de cada enlace.
¿Cómo logra esto? Si el enlace es redirigido a una URL que responde con un estado "ok", se certifica como un enlace válido. Los pormenores detallados sobre el estado de la respuesta HTTP serán exhibidos en la salida.
--stats o --s
En caso de habilitar esta opción --stats o --s
, el resultado presentará estadísticas fundamentales acerca de los enlaces detectados en el archivo. Se mostrará tanto la cantidad total de enlaces hallados como el número de enlaces únicos.
--validate --stats
Si ambas opciones son seleccionadas, el resultado incluirá estadísticas sobre los enlaces encontrados, incluyendo la cantidad de enlaces que se encuentran rotos (es decir, aquellos que no responden con "ok" al realizar una solicitud HTTP). Además, en la salida obtendrás la línea exacta donde se encuentra cada enlace.
Ejemplos de uso
md-links file.md
Analiza el archivo file.md
y muestra los enlaces encontrados, junto con la ruta del archivo y el texto vinculado.
md-links directory/
Examina todos los archivos Markdown en directorio/
y sus subdirectorios, y despliega los enlaces descubiertos en la consola.
md-links file.md --validate
Verifica los enlaces en el archivo file.md
y muestra información detallada, incluida la ruta del archivo, el texto del enlace y el estado de la respuesta HTTP al realizar una solicitud.
md-links file.md --stats
Muestra estadísticas básicas sobre los enlaces en file.md
, incluyendo el número total de enlaces y la cantidad de enlaces únicos.
md-links file.md --validate --stats
Proporciona estadísticas más detalladas sobre los enlaces en file.md
, incluyendo el número total de enlaces, la cantidad de enlaces únicos y la cantidad de enlaces rotos.