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.
Dentro de una comunidad de código abierto, nos han propuesto crear una
herramienta usando Node.js, que lea y analice archivos
en formato Markdown
, para verificar los links que contengan y reportar
algunas estadísticas.
Node.js es un entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome. Esto nos va a permitir ejecuta JavaScript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interac tuar con el sistema operativo, sistema de archivos, redes, ... En este proyecto nos alejamos un poco del navegador para construir un programa que se ejecute usando Node.js, donde aprenderemos sobre cómo interactuar con el sistema archivos, con el entorno (proceso, env, stdin/stdout/stderr), ...
El objetivo práctico de este proyecto es que aprendas cómo crear tu propia librería (o biblioteca - library) en JavaScript. Diseñar tu propia librería es una experiencia fundamental para cualquier desarrollador porque que te obliga a pensar en la interfaz (API) de tus módulos y como será usado por otros developers, debes tener especial consideración en peculiaridades del lenguaje, convenciones y buenas prácticas.
El primer paso para obtener esta librería debes de clonar este repositorio, para eso debes de ejecutar en tu consola de cualquier sistema operativo:
git clone https://github.com/Alterna87/cdmx-2018-01-FE-markdown.git
Despues de que contamos con el repositorio clonado, seguimos para instalar las dependencias que ocupamos para eso necesitas ejecutar el siguiente comando
npm install
Debido a que es la primera versión de nuestra librería sólo así podemos instalarla por el momento.