/GDL003-md-links

šŸ‘¾ Markdown Links šŸ‘¾

Primary LanguageJavaScript

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. Diagrama

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:

Ejemplo sin opciones

Ejemplo de README.md con opciĆ³n --validate :

Ejemplo con validate

Ejemplo de README.md con opciĆ³n --stats :

Ejemplo con stats

Ejemplo de README.md con --validate y --stats

Ejemplo con ambos

Tambien es posible el uso en Directorios

Ejemplo de Directorio ./ sin opciones:

Ejemplo dir sin opciones:

Ejemplo de Directorio con --validate:

Ejemplo dir validate Ejemplo dir validate2

Ejemplo de DIrectorio con --validate y --stats

Ejemplo val y stats dir

Dependencias

Para el desarrollo del proyecto se utilizaron las siguientes dependencias:

  • [marked]
  • [node-fetch]
  • [eslint]
  • [jest]
  • [chalk]
  • [node-emoji]