md-links-life

* [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 mdLinksLife from 'https://cdn.skypack.dev/md-links-life';
</script>

README

Markdown Links

Índice

1. Definición del producto

Markdown es un lenguaje de mercado muy popular en plataformas que manejan texto planos, tales como GitHub, foros, blogs, entre otros y es muy común encontrarlo por ejemplo en archivos 'README.md'.

Estos archivos suelen contener links los cuales en ocasiones pueden estar rotos o ser no válidos, es por ello que como desarrolladoras se nos pidio crear una librería la cual permitiera leer los archivos README.md y verificar sus link, para de esta forma validarlos y ver la cantidad de ellos que contiene el directorio.

2. Diagrama de Flujo

Diagrama de Flujo

3. Instalación librería.

  • Para instalar nuestra librería necesitas tener:
  • Node.js
  • npm

Pasos a seguir

1.- Instalar librería

npm i md-links-life

2.- Importarla

const mdLink = require("md-links-life")

3- En la terminal llamamos a

node index.js

3- Ejecutar comandos

  • Para ver si los link funcionan debes validarlos, para ello incorporar --validate:

--validate

  • Para ver las estadísticas de tus link debes incorporar --stats :

--stats

  • Al incorporar --stats y --validate se obtienen estadísticas de la validación.

--validateStats