MD-LINKS

Descripción

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

Estos archivos Markdown normalmente contienen links (vínculos/ligas) 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 librería desarrollada con Node.js, que permite leer y analizar archivos en formato Markdown dada una ruta, extrae los links que contengan y generar algunas estadísticas.

Instalación

Versión estable:

$ npm i @omairapalacios/md-links

$ npm i -g @omairapalacios/md-links

Guía de Uso

Utilizalo como módulo:

const mdlinks = require('@omairapalacios/md-links');

Por ejemplo:

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

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

Revisa la documentación técnica para más ejemplos en API.

A través de la linea de comandos:

$ md-links <path-to-file> {options};

Por ejemplo:

$ md-links ./some/example.md
./some/example.md https://jestjs.io/ Testing con jest
./some/example.md https://es.reactjs.org/ Librería
./some/example.md https://es.wikipedia.org/ Wikipedia

$ md-links ./some/example.md --validate
./some/example.md https://jestjs.io/ 200 Ok Testing con jest 
./some/example.md https://es.reactjs.org/ 200 Ok Librería 
./some/example.md https://es.wikipedia.org/ 400 Fail Wikipedia

Revisa la documentación técnica para más ejemplos en CLI.

LICENCIA

Licencia Copyright (c) 2020, Omaira Palacios Licencia MIT.