0.2.0 • Published 2 years ago
md-links-karina-macedo v0.2.0
MDLINKS
Índice
1. Preámbulo
Programa desarrollado en node.js que busca links de archivos.md. y permite la validación de estos como data estadística.
2. Instalación
Instale la librería con el siguiente comando:
npm i md-links-karina-macedo
3. Instrucciones de Uso
mdLinks <filepath> [options]
- filepath: Es la ruta del archivo a ejecutar en el programa.
Las options en este programa son:
- --validate: Podrás ver si sus enlaces están rotos o bien y obtener el estado de http
- --stats: Podrás ver enlaces totales y únicos.
- --stats --validate: Podrás ver enlaces totales, únicos y rotos
Los comandos a ejecutar son los siguientes:
mdLinks --help
Obtendrá los comando relacionados al programa:
mdLinks filepath
Obtendrá los datos de la siguiente manera:
- href: URL encontrada.
- text: Texto que aparece dentro del link.
- file: Ruta del archivo donde se encontró el link.
mdLinks filepath --validate
Obtendrá los datos de la siguiente manera:
- href: URL encontrada.
- text: Texto que aparece dentro del link.
- file: Ruta del archivo donde se encontró el link.
- status: Código de respuesta HTTP.
- ok: Mensaje fail en caso de fallo u ok en caso de éxito.
mdLinks filepath --stats
Obtendrá los datos de la siguiente manera:
- total: Cantidad de links en la ruta
- unique: Cantidad de links unicos en la ruta
mdLinks filepath --stats --validate
- total: Cantidad de links en la ruta
- unique: Cantidad de links unicos en la ruta
- broken: Cantidad de links rotos en la ruta
4. Documentación del Proyecto
La documentación de la realización de este proyectos se encuentra en el siguiente apartado: