Skip to content

Creation of a library that is responsible for validating if there are broken links or not. You can also view the statistics and the total number of links in a file or folder.

EstefaniConislla/LIM015-md-links

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Links

Introducción

Encuentra todos los links dentro de un archivo Markdown. Funciona cuando se ingresa una ruta relativa/ absoluta llamando directamente a un archivo Markdown que se encuentre en la posición relativa en la que está el usuario.

Instalación

$ npm i estefanica

Usage

Implementa los modulos de node.js:

  • fs
  • path
  • console

Opciones

Se puede utilizar el paquete con una serie de opciones.

  • Sin opciones: al ejecutar el paquete sin opciones se genera un arreglo que contine informacion de cada link encontrado en el archivo MD:

View

  • Help: al ejecutar el paquete con la opción --help se genera un arreglo que contiene informacion de cada options:

View

  • Validate: al ejecutar el paquete con la opción validate --v o --validate, se genera el arreglo anterior, agregando además, para cada link encontrado el status de cada uno de ellos, mediante una llamada http.

View

  • Stats: al ejecutar el paquete con la opción stats --s o --stats, se genera un objeto con el total de link y con la cantidad de links únicos encontrados dentro del archivo(s).

View

  • Stats y Validate: al ejecutar el paquete con las opciones --s --v o --stats --validate, se genera un objeto con el total de link, con la cantidad de links que se encuentran "OK" y la cantidad de los links que se encuentran "Broken".

View

About

Creation of a library that is responsible for validating if there are broken links or not. You can also view the statistics and the total number of links in a file or folder.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%