md-lunin-links v0.1.1

Markdown Links

Índice

• 1. Preámbulo
• 2. Resumen del proyecto
• 3. Diagrama de Flujo
• 4. Guîa de Instalaciòn
• 5. Manual de Usuario
• 6. Links de Referencias

1. Preámbulo

Markdown es un lenguaje de marcado que facilita la aplicación de formato a un texto empleando una serie de caracteres de una forma especial. En principio, fue pensado para elaborar textos cuyo destino iba a ser la web con más rapidez y sencillez que si estuviésemos empleando directamente HTML. Y si bien ese suele ser el mejor uso que podemos darle, también podemos emplearlo para cualquier tipo de texto, independientemente de cual vaya a ser su destino.

2. Resumen del proyecto

Este proyecto se Centra en la creaciòn de una herramienta de línea de comando (CLI) así como supropia librería (o biblioteca - library) en JavaScript.

En esta oportunidad bajo el nombre de md-Links se crea una librería que facilita la lecturay análisis de los archivos con formato Markdown, nos alejamos un poco del navegador para construir un programa que se ejecute usando Node.js. como su nombre lo indica su ejecuciòn es a travès de lineas de comandos que nos premiten verificar los enlaces (Links) que se encuentran dentro de directorios y archivos con extension .md, generando estadisticas sobre el total de los mismo, si estos son vâlidos, ùnicos y Rotos.

3. Diagrama de Flujo

Para el desarollo de este proyecto se diseño un Diagrama de flujo, el cual se ejecutò paso a paso mediante mètodo SCRUM.

4. Guîa de Instalaciòn

Ingresando el siguiente comando en la terminal de su Proyecto, podrà llevar esta Libreria a ejecuciòn

npm i md-lunin-links

5. Manual de Usuario

Luego de instalada la libreria, a travès de la terminal (GitBash recomendado) ingresando las siguientes instrucciones, podràs acceder a los resultados de CLI:

Ingrese mdLinks <path-to-file>

$ mdLinks ./Directory/example.md 
[{
    href: 'https://amExample.com/install',
    text: 'am a example',
    pathMd: 'C:\\Users\\Dell\\Desktop\\Directory\\example.md'
  }]

Ingrese mdLinks <path-to-file> --validate

[{
    href: 'https://amExample.com/install',
    text: 'am a example',
    pathMd: 'C:\\Users\\Dell\\Desktop\\Directory\\example.md',
    code: 200,
    status: 'OK'
  }]

Ingrese mdLinks <path-to-file> --stats

{ total: 30, unique: 28 }

Ingrese mdLinks <path-to-file> --stats --validate

{ total: 30, unique: 28, broken: 7 }

6. Links de Referencias

• Acerca de Node.js - Documentación oficial
• Que es markdown
• Node.js http.get - Documentación oficial
• Expresiones Regulares
• Aprende como aplicar Jest Mock
• Publicar packpage
• Crear módulos en Node.js
• Leer un archivo
• Leer un directorio
• Path
• Linea de comando CLI

L a F u e r z a e s t â C o n t i g o