Markdown Links

MD LINKS

Libreria que busca y trae estadisticas de links que se encuentren en archivos Markdown.

1. ¿CÓMO SE INSTALA?

Para hacer uso de la libreria como módulo se debe instalar en la terminal de la siguiente forma:

              npm i md-linkscjl

2. ¿CÓMO SE USA?

Actualmente la libreria está disponible solamente para ocuparla desde CLI. Para poder acceder a ella se debe utilizar de la siguiente manera:

            md-link <path to file/ruta archivo>

Al indicar la ruta del archivo, la libreria devolvera la siguiente información: File = Indicando el archivo que se indico. Link = La URL del link que se encuentra en el archivo. Text = Texto con el cual se encuentra referido el link dentro del archivo md.

Además del funcionamiento predeterminado, se puede utilizar la siguiente opción:

--VALIDATE

Para acceder a la opción de validate, se debe iniciar de la siguiente forma: md-link <path to file/ruta archivo> --validate o --v

Dicha opción devolverá lo siguiente: El estado de es

Lo que permite realizar la opción validate es obtener el estado HTTP del link que se encuentra dentro del archivo md.

En próximas versiones se implementarán las opciones de --STAT y --STAT--VALIDATE.

3. DIAGRAMA DE FLUJO

La presente libreria ha sido realizada acorde al siguiente diagrama de flujo:

4. LIBRERIAS UTILIZADAS

Las siguientes librerias fueron utilizadas en la realización de este proyecto:

• [Colors] (https://www.npmjs.com/package/colors)
• [Fetch] (https://www.npmjs.com/package/fetch)

5. PRÓXIMAS ITERACIONES

Se espera que para las próximas versiones de esta libreria se puedan implementar los siguientes elementos: [] Opción --STATS [] Opción --STATS--VALIDATE [] Uso de librería como módulo

AUTORA

CJL / Generación 14 SCL Laboratoria