jofontea-md-links

jofontea-md-links es una librería para extraer enlaces de archivos Markdown y realizar diversas operaciones como validación y estadísticas.

Índice

• Instalación
• Uso
  • Obtener información de enlaces
  • Validar enlaces
  • Estadísticas de enlaces
  • Validar enlaces y obtener estadísticas
• Ejemplos de Resultados
  • Resultado solo con la ruta
  • Resultado con --validate
  • Resultado con --stats
  • Resultado con --stats y --validate
• Contribución

Instalación

Para instalar jofontea-md-links, asegúrate de tener Node.js instalado en tu sistema. Luego, utiliza el siguiente comando:

npm install jofontea-md-links

Uso

Obtener información de enlaces

Para obtener información sobre los enlaces en un archivo Markdown, utiliza el siguiente comando:

jofontea-md-links "ruta/al/archivo.md"

El resultado será un array que muestra información sobre los enlaces, como el href (URL), el text (texto del enlace) y la file (ruta del archivo).

Validar enlaces

Para validar el estado de los enlaces en un archivo Markdown, utiliza el siguiente comando:

jofontea-md-links "ruta/al/archivo.md" --validate

El resultado mostrará información adicional, como el status (código de estado HTTP) y el ok (estado de la validación).

Estadísticas de enlaces

Para obtener estadísticas básicas sobre los enlaces en un archivo Markdown, utiliza el siguiente comando:

jofontea-md-links "ruta/al/archivo.md" --stats

El resultado mostrará el número total de enlaces y el número de enlaces únicos.

Validar enlaces y obtener estadísticas

Para realizar una validación de enlaces y obtener estadísticas al mismo tiempo, utiliza el siguiente comando:

jofontea-md-links "ruta/al/archivo.md" --stats --validate

El resultado mostrará el número total de enlaces, el número de enlaces únicos, el número de enlaces activos y el número de enlaces rotos.

Ejemplos de Resultados

Resultado solo con la ruta

jofontea-md-links "fake-README.md"

Resultado links [
  {
    href: '#1-consideraciones-generales',
    text: '1. Consideraciones generales',
    file: 'ruta/al/archivo.md'
  },
]

Resultado con --validate

jofontea-md-links "fake-README.md" --validate

Resultado de validación [
  {
    href: '#1-consideraciones-generales',
    text: '1. Consideraciones generales',
    file: 'ruta/al/archivo.md',
    status: 404,
    ok: 'fail'
  },
]

Resultado con --stats

jofontea-md-links "fake-README.md" --stats

Estadísticas { total: 5, unique: 5 }

Resultado con --stats y --validate

jofontea-md-links "fake-README.md" --stats --validate

Resultado de validación y estadísticas { total: 5, unique: 5, active: 2, broken: 3 }

Contribución

¡Todas las contribuciones son bienvenidas! Si deseas colaborar en este proyecto, por favor sigue estos pasos:

1. Realiza un fork del repositorio.
2. Crea una rama con la nueva funcionalidad o solución a un problema.
3. Envía un pull request.

¡Gracias por contribuir!