MdLinks es una herramienta de línea de comando(CLI) y una librería, que permite extraer los links de un archivo tipo Markdown(md), identifica los links que esten dentro de dichos archivos, y evalua cuales están funcionando y cuales están rotos. Adicionalmente entrega esta información al usuario como estadísticas, de la siguiente información:
Total de links
Links únicos
Links rotos
Diagrama de flujo, del paso a paso del paquete creado y lo que se queria obtener de él.
Para hacer uso de la librería ejecuta en la terminal el siguiente comando:
npm install md-linksPXAA21
Si tiene problemas con el anterior comando, ejecutelo pasandole la ruta de donde quedo clonado el proyecto Md-links
luego deberas, de ejecutar el siguiente comando para que el ejecutable sea leido
npm link
Para utilizar esta librería puedes ejecutar los siguientes comandos, desde la terminal:
md-links <path> <options>
- options puede ser:
- Si necesitas conocer y validar los link encontrados en archivos .md:
md-links <path> --validate o --v
Devuelve:
{
href: URL encontrada.
text: Texto que aparecía dentro del link (<a>).
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.
}
-
Si necesitas conocer estadistica de cuantos link se encontraron y cuantos son únicos:
md-links <path> --stats o --sDevuelve:
Total: 3 ; Unique: 3
-
Si necesitas conocer, validar los link y devolver una estadisticas con los links rotos:
md-links <path> --validate --stats o --v --sDevuelve:
Total: 3 ; Unique: 3 ; Broken: 1
-
si solo deseas conocer los link encontrados y donde fueron encontrados, ingresa:
md-links <path>Devuelve:
{
href: URL encontrada.
text: Texto que aparecía dentro del link (<a>).
file: Ruta del archivo donde se encontró el link.
}
- Node - Utilizado para ejecutar javascript en consola
- JavaScript - Lenguaje de programación
- GitHub- Usado guardar el repositorio del proyecto
- Paula Ximena Anzola - Ingeniera ambiental / Frontend Developer - Proyectos