the-links

* [1. Preámbulo](#1-preámbulo) * [2. Resumen del proyecto](#2-resumen-del-proyecto) * [3. Objetivos de aprendizaje](#3-objetivos-de-aprendizaje) * [4. Consideraciones generales](#4-consideraciones-generales) * [5. Criterios de aceptación mínimos del p

Usage no npm install needed!

<script type="module">
  import theLinks from 'https://cdn.skypack.dev/the-links';
</script>

README

Markdown Links

Este modulo fue diseñado con la finalidad de encontrar los links existentes en los archivos markdown y poder verificar si siguen vigentes.

Funcionamiento

The-links sigue la lógica del siguiente diagrama de flujo.

Diagrama

Instalación

Para instalar la dependencia en tu proyecto debes ejecutar el siguiente comando desde tu consola .

 $ npm i the-links

Funcionamiento Interfaz de Línea de Comando)

  • Ruta sin opciones

Para poder ejercutar the-links debes ingresar el siguiente comando seguido por la ruta relativa o absoluta del archivo tipo .md que quieres revisar. Está ejecución imprimirá todos los links encontrados.


$ viri-links ./some/example.md

viri-links

  • Ruta con opción validate

Para conocer si los links de un archivo siguen vigentes o se han roto, debes ingresar el siguiente comando el cual imprimirá todos los links y en caso de seguir activos, su estatus será "Ok", de lo contrario se imprimirá "Not Found".


$ viri-links ./some/example.md validate

viri-links

  • Ruta con opción stats

El siguiente comando imprimirá el total de links encontrados y el total de los que no se repiten.


$ viri-links ./some/example.md stats

viri-links

  • Ruta con opción validate y stats

Para obtener los links validados y el total de los mismos debes ingresar el siguiente comando en el orden que se muestra.


$ viri-links ./some/example.md validate stats

viri-links