mdlinks-danieladucuara v0.1.0
🔗 Markdown Links 🔗
Índice
- 1. Preámbulo
- 2. Descripción
- 3. Diagrama de flujo
- 4. Instalación
- 5. Guía de uso
- 6. Tecnologías utilizadas
- 7. Autor
1. Preámbulo 🤓
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.
2. Descripción 💻
Es una herramienta de línea de comando(CLI) y una librería, que permite extraer los links de un archivo tipo Markdown(md), e identifica cuales están funcionando y cuales están rotos. Adicionalmente esta información se puede entregar al usuario como estadísticas donde se puede ver:
- Total de links
- Links únicos
- Links rotos
3. Diagrama de flujo 🪢
Para llevar a cabo el proyecto se hizo necesario realizar un diagrama de flujo. El cual se muestra a continuación:
4. Instalación 🔧
Para hacer uso de la librería ejecuta en la terminal el siguiente comando:
- npm install mdlinks-danieladucuara
5. Guía de uso 📝
Para utilizar esta librería puedes ejecutar los siguientes comandos: 1. Si necesitas conocer la ruta de donde proviene los links, su enlace, e información sobre este, solo ingresas la ruta --> mdlinks 2. Si además de la información anterior necesitas conocer si los enlaces en tu archivo están funcionando o no, ingresas el siguiente comando: mdlinks --v ó mdlinks --validate 3. Si quieres saber cuantos links hay en total en tu archivo o directorio, y cuantos son unicos, ingresa: mdlinks --s ó mdlinks --stats 4. Por último, si deseas consultar cuantos links se encuentran rotos, puedes ingresar: mdlinks --s --v ó mdlinks --stats --validate
6. Tecnologias utilizadas 🛠️
- Node - Utilizado para ejecutar javascript en consola
- Lucid.app - Utilizado para la creación del diagrama de flujo
- JAVASCRIPT - Lenguaje de programación
- GitHub- Usado guardar el repositorio del proyecto
7. Autor ✒️
- Daniela Ducuara - Daniela1421
2 years ago