Markdown Links
Resumen del proyecto
Es una herramienta usando Node.js, que lea y analice archivos
en formato Markdown
, para verificar los links que contengan y reportar
algunas estadísticas.
Instalación
El módulo es instalable via npm install jossacosta-md-links
.
mdLinks(path, options)
Argumentos
path
: Ruta absoluta o relativa al archivo o directorio.options
: Un objeto con las siguientes propiedades:validate
: Booleano que determina si se desea validar los links encontrados.
Valor de retorno
La función retorna una promesa que resuelva a un arreglo
(Array
) de objetos (Object
), donde cada objeto representa un link y contiene
las siguientes propiedades:
href
: URL encontrada.text
: Texto que aparecía dentro del link (<a>
).
Ejemplo
const mdLinks = ; ; ; ;
CLI (Command Line Interface - Interfaz de Línea de Comando)
El ejecutable de nuestra aplicación se ejecut de la siguiente manera a través de la terminal:
validate-md <path-to-file> [options]
Por ejemplo:
$ validate-md README.mdCorrect File extension[