1.2.1 • Published 3 years ago
karinna88-md-links v1.2.1
Markdown Links
Índice
- 1. Objetivo del Proyecto
- 2. Especificaciones Técnicas
- 3. Diagrama de Flujo
- 4. Instalación
- 5. Modo de Uso
1. Objetivo del Proyecto
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.Especificaciones Técnicas
Lenguajes |
---|
JavaScript ES6 |
Ejecución |
Node.js |
Testing |
Jest |
Dependencias y módulos |
node-fetch |
Path |
File System (fs) |
3. Diagrama de Flujo
4. Instalación
Para iniciar Markdown Links debes instalar: 1. instalar Node.js usando el comando
npm install
- instalar la librería con el siguiente comando en la terminal:
npm i karinna88-md-links
- También debes instalar las siguientes librerías anexas:
$ npm install node-fetch
5. Modo de uso
Para hacer uso de la librería ejecuta el siguiente comando en la terminal:
En caso de ser un archivo .md
md-limk tuarchivo.md
En caso de ser una carpeta
md-limks carpeta/tuarchivo.md
| Opciones | Comando |
| ----------------- | ----------------------- |
| Estadistica | --stats |
| Validar | --validate |
| Estadistica y validar | --validate--stats |