MdLinks
¿Qué es Markdown?
Markdown es un lenguaje de marcado
ligero muy popular entre developers. Es usado en muchísimas plataformas que
manejan texto plano (GitHub, foros, blogs, ...), y es muy común
encontrar varios archivos en ese formato en cualquier tipo de repositorio
(empezando por el tradicional README.md
).
Estos archivos Markdown
normalmente contienen links (vínculos/ligas) que
muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de
la información que se quiere compartir.
Por lo cuál se crea esta librería que vamos a poder implementar con la finalidad de verificar
el status de nuestros links.
Diagrama de flujo
A continuación se muestra el diagrama de flujo elaborado para la solución de este proyecto.
Usabilidad
Puede ser usado con archivos o directorios.
Los comandos ejecutables son:
--validate
--stats
Pueden aplicarse uno por uno o ambos.
Ejemplos de usabilidad
Ejemplo de README.md sin opciones:
--validate
:
Ejemplo de README.md con opción
--stats
:
Ejemplo de README.md con opción
--validate
y --stats
Ejemplo de README.md con
Tambien es posible el uso en Directorios
Ejemplo de Directorio ./ sin opciones:
--validate
:
Ejemplo de Directorio con
--validate
y --stats
Ejemplo de DIrectorio con
Dependencias
Para el desarrollo del proyecto se utilizaron las siguientes dependencias:
- [marked]
- [node-fetch]
- [eslint]
- [jest]
- [chalk]
- [node-emoji]