sandymarmolejo-md-links v1.0.3

Md Links

Información General

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, etc), y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio. (Ejemplo: README.md).

Estos archivos Markdown normalmente contienen links que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Md links es una herramienta que usa Node.js, para leer y analizar archivos en formato Markdown, para verificar los links contenidos y reportar algunas estadísticas.

Instalación

npm i sandymarmolejo-md-links --save

Usos

const mdLinks = require("md-links");

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

Opciones

MdLink tiene 2 opciones, ambas son opcionales y pueden usarse juntas también:

--validate

Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no, incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

Por ejemplo:

--stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links.

Por ejemplo:

--stats y --validate

También podemos combinar las opciones para obtener estadísticas que necesiten de los resultados de la validación.

Por ejemplo:

CLI (Command Line Interface - Interfaz de Línea de Comando)

Al colocar md-links en la terminal y --help se muestra el mensaje de bienvenida y las opciones que puedes escoger.

Por ejemplo:

Si no se ingresa ninguna ruta ni alguna de las opciones, se mostrará un mensaje de opción inválida y te volverá a mostar el mensaje de bienvenida y las opciones que puedes escoger.

md-links <path-to-file> [options]

Por ejemplo:

Por default identifica el archivo markdown (a partir de la ruta que recibe como argumento), analiza el archivo Markdown e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link.