md-linkyan

Índice

• 1. Introducción
• 2. Resumen del proyecto
• 3. Instrucciones de uso
• 4. Instalación
• 5. Interfaz de Linea de Comando CLI
• 6. Referencias utilizada

1. Introducción

Markdown es un lenguaje de marcado que nos permite dar formato a un texto de manera rápida y sencilla. Inicialmente diseñado para facilitar la creación de contenido web sin la necesidad de utilizar HTML directamente, se ha convertido en una herramienta versátil para dar estilo a cualquier tipo de texto, independientemente de su destino.

2. Resumen del proyecto

El objetivo es crear una herramienta utilizando Node.js para analizar archivos en formato Markdown y verificar los links que contienen. La herramienta proporcionará estadísticas sobre los links encontrados, como la cantidad total de links, la cantidad de links únicos y la cantidad de links rotos o no válidos.

Esta herramienta será útil para desarrolladores y comunidades de código abierto, ya que les permitirá identificar y corregir los links rotos en sus archivos Markdown, lo que mejorará la calidad y utilidad de la información compartida en plataformas como GitHub, foros y blogs.

3.Instrucciones de uso

Las siguientes instrucciones le permitirán instalar la librería en su terminal.

md-links Si pasamos la opción md-links nos retornará instrucciones acerca de los comandos.

$ md-links 

4.Instalación

La instalación se puede realizar por npm:

$ npm i md-linksyan              

5. Interfaz de Linea de Comando (CLI)

Se ejecuta de la siguiente manera a través del terminal:

$ md-links  <path> [options]

Ejemplo:

$ md-links <path>

Opciones

--validate Al ingresar el comando md-links path --validateel módulo hace una petición HTTP para averiguar si el link funciona o no, retonando las siguientes propiedades.

$ md-links <path> --validate

--stats Si pasamos la opción --stats el output (salida) obtenemos un texto con estadísticas básicas sobre los links, como el número total de links y links únicos.

$ md-links <path> --stats

--validate --stats o --stats --validate Si pasamos la opción --validate y --stats o Si pasamos la opción --stats y --validate nos retornara las estadísticas de los links totales, únicos y rotos.

$ md-links  <path> --validate --stats

$ md-links <path>  --stats --validate

6. Referencias utilizadas

• File-Sytem
• Path module aquí esta la documentación (https://nodejs.org/api/path.html)
• axios aquí esta la documentación (https://axios-http.com/docs/intro)
• chalk
• marked aquí esta la documentación (https://marked.js.org/)
• cheerio aquí esta la documentación (https://cheerio.js.org/docs/intro)
• Babel

Realizado por :

    YanettrDEV007😎