md-links-kyvh v0.1.0

MD-Links

Index

• MD-Links-kyvh
• Instalación
• Guía de uso
• API
• Diagrama de flujo
• Imagen resultado de ejecución de libreria

MD-Links-kyvh 🚀

Cuarto proyecto de especialización Front End generación 16 de Laboratoria Markdown Links, es una libreria que extrae y valida cada link que haya dentro de archivos en formato markdown.

Instalación 🔧

Para comenzar la instalación de esta libreria necesitas primero instalar Node.js y luego ejecutar el comando:

npm install -g md-links-kyvh

Guía de uso 📋

Una vez instalado, debes ejecutar el siguiente comando en la terminal:

$ md-links-kyvh ./ --validate

API

mdLinks(path, options)

** Argumentos: - path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, debe resolverse como relativa al directorio desde donde se invoca node - current working directory). - options: Un objeto con únicamente la siguiente propiedad: - validate: Booleano que determina si se desea validar los links encontrados.

Diagrama de flujo 🛠️

Imagen resultado de ejecución de libreria ⚙️