@nachasilva/md-links v2.0.0

Índice

• 1. Introducción
• 2. Instalación
• 3. ¿Cómo se usa?
• 4. Ejemplos de uso
• 5. Demo
• 6. Autora

1. Introducción

Markdown es un lenguaje de marcado ligero muy popular en plataformas que manejan texto plano como GitHub, foros, blogs, etc. y es muy común encontrar varios archivos en ese formato en cualquier tipo 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.

Es por esto que se crea este proyecto, una herramienta de línea de comandos (CLI) junto con una librería que permite buscar y analizar enlaces en archivos con extensión .md optimizando la experiencia de trabajo con contenido Markdown.

2. Instalación

1. Instala Node.js en tu computador si aún no lo has hecho.
2. Abre tu terminal y navega hasta el proyecto donde deseas utilizar MD-Links.

Instalar el paquete de forma global:

npm install -g @nachasilva/md-links

Instalar el paquete localmente en el directorio del proyecto actual:

npm i @nachasilva/md-links

3. ¿Cómo se usa?

Como módulo:

const mdLinks = require("md-links");

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }, ...]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }, ...]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }, ...]
  })
  .catch(console.error); 

Como CLI:

Ya teniendo la librería instalada, puedes usarla proporcionando los datos en la terminal de la siguiente manera:

md-links <path-to-file> [options]

• path: Ruta absoluta o relativa al archivo o directorio
• options: Para validar o sacar estadísticas ya sea --validate --stats --stats --validate --help

4. Ejemplos de uso

Una vez que hayas instalado md-links, puedes utilizarlo de la siguiente manera:

1. Analiza el archivo Markdown e imprime los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link.

md-links ruta

Ejemplo:

$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

2. Realiza la petición HTTP para verificar la validez de cada enlace. Además de mostrar ok si el link funciona o fail en caso de estar roto, junto con su status de la respuesta recibida.

-- validate

Ejemplo:

$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google

3. Entrega un texto con estadísticas acerca de los enlaces encontrados.

--stats

Ejemplo:

$ md-links ./some/example.md --stats
Total: 3
Unique: 3

4. Obtener estadísticas que necesiten de los resultados de la validación.

--stats --validate

Ejemplo:

$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1

5. Acceder a ayuda en consola

--help

5. Demo

1. md-links ruta

2. md-links ruta -- validate

3. md-links ruta --stats

4. md-links ruta --stats --validate

5. md-links --help

6. Autora

Ignacia Silva - agosto 2023. Si tienes alguna pregunta o sugerencia, no dudes en contactarme Aquí

Espero que te ayude mucho md-links en tus proyectos!

Happy linking! 📎🌟