md-links-karjc

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

README

Markdown Links - mdLinks

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, entre otros), por lo que es muy común encontrar archivos en ese formato en diferentes tipos de repositorio (empezando por el tradicional README.md). Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

mdLinks permite el usuario recorrer la carpeta en busca de archivos de extencion .md (archivos markdown) y comprobar el estado de los enlaces presentes en cada archivo verificando si estos se encuentran OK (status 200) o Broken (status !==200). el resultado se presenta en la terminal (o consola).

Instalación

Para instalar mdLinks, en tu terminal dentro de la carpeta de los archivos a revisar:

npm i md-links-karjc --save

Para hacer uso de la libreria:

Import mdLinks

import { mdLinks } from 'md-links-karjc';

Require mdLinks

const mdLinks = require ('md-links-karjc');

Una vez la libreria se encuentre importada (import) o requerida (require), podras usar sus componentes.

const mdLinks = require ('md-links-karjc');

console.log(mdlinks)

Herramientas:

  • Node.js
  • JavaScript

Dependecias:

  • fetch: ^1.1.0
  • eslint: ^6.8.0
  • jest: ^25.1.0

License

ISC

Autora:

KarJC

Keywords

markdown, .md, liks, fetch, url