show-markdown-links v0.2.0

Show Markdown Links

Índice

• 1. Show Markdown-Links
• 2. Instalación
• 3. Uso
• 4. Herramientas y Librerias Utilizadas
• 5. Autor

1. Show Markdown-Links 🔗

¿Qué es Show Markdown Links

Show Markdown Links es una librería que lee y analiza archivos en formato MARKDOWN. Verifica los links que contenga el archivo .md, muestra su estado y cuenta tanto el total de los enlaces, como los que son válidos y los que no.

Puedes conocerla y probarla aquí.

2. Instalación 🚀

Para utilizar Show Markdown Links debes:

1.- instalar Node.js usando el comando

npm install

2.- Instalar Show Markdown Links con el siguiente comando:

npm i show-markdown-links

Y listo! ya puedes comenzar a usarlo.

3. Uso 💻

Si sólo quieres ver los links extraidos de tus archivos .md tienes dos opciones, uno analizara el archivo especifico y el otro algún directorio: Puedes extraer todos los links presentes en tu archivo o directorio con alguna de las siguientes líneas:

npm show-markdown-links nombredetuarchivo.md
npm show-markdown-links ./(Directorio actual)

A un costado de tus enlaces se mostrará con un ticket (✔) si el enlace está disponible, con Error 404 si corresponde o con Error en cualquier otro caso.

Puedes utilizar la opción disponibles pa el conteo resumido de los links en los que encontrarás los válidos, inválidos y el total. Para esto, intenta con una de éstas líneas en tu terminal:

npm show-markdown-links nombredetuarchivo.md --validate
npm show-markdown-links ./(Directorio actual) --validate

4. Herramientas y Librerias Utilizadas 🛠️

• Git y GitHub – Para el repositorio e issues.
• Node – Para el entorno de ejecución de JavaScript.
• Node – Para versiones e instalación.
• Fetch – Para extraer el contenido de los links/urls.
• Marked – Para compilar.
• Chalk – Para colorear y destacar los resultados de la ejecución.

5. Autor ✒️

• Anelisse Acevedo GitHub :octocat: - Front-end Developer.