MD Links

Este módulo de node.js encuentra y muestra los links que se encuentran en un archivo .md, o de todos los archivos .md encontrados en una carpeta.

Instrucciones

Instalación

El módulo se puede instalar escribiendo en consola npm i @dsandovalm/md-links

Uso

mdLinks recibe como parametros una ruta (obligatorio) y un objeto con opciones y retorna una promesa que resuelve un arreglo de links o un error.

Los links contienen la ruta del archivo en que se encontraron, el link y el texto en la etiqueta y adicionalmente el estado http del link y un mensaje de ok o fail cuando se validan.

Documentación

Para importarlo en tu proyecto necesitarás colocar const mdLinks = require('@dsandovalm/md-links')

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

/*

  Input
  
    ruta :string // Obligatorio. La ruta relativa o absoluta del archivo .md o una carpeta
    
    opciones :objeto // Opcional. Opciones adicionales para ejecutar la función
      validate :booleano // 
      
  Output :link[]
  
    link = 
      {
        file :string, // La ruta del archivo donde se encontró el link
        href :string, // La URL del link
        text :string, // El texto que aparece en la etiqueta del link
        
        // - - - Atributos que se incluyen solo cuando validate = true
        ok :string, // Este es ok o fail
        status :number // El estado http del link
      }
    
*/

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

Para usarlo desde la consola

md-links muestra un listado de los links encontrados

md-links --stats muestra la cantidad de links encontrados en el archivo

md-links --validate muestra un listado de los links encontrados junto a su estado de validación

md-links sin parametros, md-links help, o md-links seguido por un comando no valido muestra el menu de ayuda principal

PowerShell> md-links

    md-links [path] <options>
        busca un archivo .md o carpeta en la ruta y muestra un listado de los links
    md-links [cmd] <options>
        version ............ muestra la version actual del paquete
        help ............... muestra el menu de ayuda

md-links help path 

    md-links [path] <options>
        validate .............. valida el estado de los links encontrados en el/los archivo(s)
        stats ................. muestra la cantidad de links encontrados

@dsandovalm/md-links