ifdotcom-mdlinks v1.0.3

Indice

• Indice
• 1. MDLINKS
• 2. Instalación
• 3. Casos de uso
• 4. MDLINKS como módulo
• 5. Desarrollo

1. MDLINKS

mdLinks es una poderosa librería diseñada para extraer enlaces de archivos Markdown (MD) y proporcionar estadísticas útiles sobre esos enlaces. Con esta herramienta, los desarrolladores pueden automatizar la tarea de encontrar enlaces en archivos MD y obtener información valiosa sobre ellos de manera rápida y eficiente. Al utilizar mdLinks, los usuarios pueden pasar una ruta o un directorio como argumento y la librería buscará todos los archivos con extensión .md dentro de la ruta especificada. Una vez que los archivos MD son identificados, mdLinks extrae los enlaces contenidos en cada archivo y devuelve una tabla con información detallada sobre cada enlace. Esta información incluye la URL del enlace, el texto de anclaje y la ruta del archivo en el que se encuentra. Además de la extracción de enlaces, mdLinks ofrece estadísticas útiles sobre los enlaces encontrados. Proporciona el número total de enlaces encontrados, así como el número de enlaces únicos, es decir, aquellos que no se repiten. mdLinks también ofrece la capacidad de verificar el estado de cada enlace extraído. Puede detectar enlaces rotos, es decir, aquellos que conducen a páginas web no disponibles o que devuelven un código de error.

2. Instalación

  npm i ifdotcom-mdlinks

3. Casos de uso

Caso 1

  md-links <path-to-file-or-directory>

Valores de retorno:

• href: URL encontrada.
• text: Texto que aparecía dentro del link.
• file: Ruta del archivo donde se encontró el link.

Caso 1 | Ejemplo

Caso 2

  md-links <path-to-file-or-directory> --validate

o

  md-links <path-to-file-or-directory> -v

Valores de retorno:

• href: URL encontrada.
• text: Texto que aparecía dentro del link.
• file: Ruta del archivo donde se encontró el link.
• status: Código de respuesta HTTP.
• statusText: Mensaje fail en caso de fallo u ok en caso de éxito.

Caso 2 | Ejemplo

Caso 3

  md-links <path-to-file-or-directory> --stats

o

  md-links <path-to-file-or-directory> -s

Valores de retorno:

• total: Links encontrados.
• unique: Links que no se repiten.

Caso 3 | Ejemplo

Caso 4

  md-links <path-to-file-or-directory> --validate --stats

o

  md-links <path-to-file-or-directory> -v -s

Valores de retorno:

• total: Links encontrados.
• unique: Links que no se repiten.
• broken: Links que no son válidos.

Caso 4 | Ejemplo

4. MDLINKS como módulo

Además, tienes la opción de importar el módulo de una forma alternativa:

    const mdlinks = require("ifdotcom-mdlinks").mdLinks;

    mdlinks('<path-to-file-or-directory>',{validate: false, stats: false})
    .then((res)=>{
        console.log(res)
    })

5. Desarrollo

• Planificación | GitHub Projects
• Diagrama de flujo | Diagrama de Flujo