md-links-tiare-ism
v0.1.1
Published
* [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. Consideraciones técnicas](#5-consider
Downloads
3
Readme
Markdown Links
Descripción
Md-Links es una librería en Node.js diseña para analizar enlaces dentro de archivos [Markdown]. Este proyecto ofrece dos formas de integración: como módulo instalable desde GitHub, permitiendo su incorporación en otros proyectos, y como una interfaz de línea de comandos (CLI) brindando la flexibilidad de ser utilizada desde la terminal.
Características Destacas:
- Validación de Enlaces:
md-links
facilita la tarea de verificar la validez de los enlaces presentes en documentosMarkdown
. - Interacción con el Sistema de Archivos: Aprovechando la capacidad de [Node.js], la librería proporciona funciones para buscar y leer archivos, ofreciendo una gestión eficiente de documentos.
- Interfaz de Línea de Comandos (CLI): La CLI de
md-links
permite realizar análisis de enlaces de manera rápida y directa desde la terminal.
Instalación
Podrás instalar esta librería md-links
utilizando NPM (Node Package Manager) de la siguiente manera:
- Abrir la terminal bash y ejecutar el siguiente comando:
npm i md-links-tiare-ism
- Uso:
md-links [ruta del archivo] [options]
- ruta del archivo: reemplazar con la ruta del archivo que se desea analizar.
- options: acepta dos parametros:
--validate
realiza una verificación adicional de cada enlace para determinar su estado.--stats
mostrará estadísticas simples sobre los enlaces encontrados.--validate
--stats
uso combinado, mostrará estadísticas sobre los enlaces y también los validará.
Diagrama de Flujo
Este diagrama de Flujo ilustra el proceso y la lógica de md-links
.