# md-links-laumontero

> * [1. Introducción](#1-introducción) * [2. Descripción](#2-descripción) * [3. Diagrama de flujo](#3-diagrama-de-flujo) * [4. Modo de uso](#4-mode-de.uso) * [5. Desplegado en NPM](#5-desplegado-en-NPM)

Latest version **0.1.1** (published 2023-06-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install md-links-laumontero
pnpm add md-links-laumontero
yarn add md-links-laumontero
bun add md-links-laumontero
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2023-06-13 |
| First published | 2023-06-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.x |
| Dependencies | 4 |
| Unpacked size | 35.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | lauracmonterom |

## Links

- npm: https://www.npmjs.com/package/md-links-laumontero
- Repository: https://github.com/LauraCMonteroM/DEV005-md-links
- Homepage: https://github.com/LauraCMonteroM/DEV005-md-links#readme
- Issues: https://github.com/LauraCMonteroM/DEV005-md-links/issues
- npm.io page: https://npm.io/package/md-links-laumontero

## Dependencies (4)

- [jest](https://npm.io/package/jest.md) ^29.5.0
- [axios](https://npm.io/package/axios.md) ^1.4.0
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.11

## Recent versions

- 0.1.1 (latest) — 2023-06-13
- 0.1.0 — 2023-06-13

## README

# Markdown Links

## Índice

* [1. Introducción](#1-introducción)
* [2. Descripción](#2-descripción)
* [3. Diagrama de flujo](#3-diagrama-de-flujo)
* [4. Modo de uso](#4-mode-de.uso)
* [5. Desplegado en NPM](#5-desplegado-en-NPM)

***

## 1. Introducción

 Markdown 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](https://nodejs.org/), que lea y analice archivos
en formato `Markdown`, para verificar los links que contengan y reportar
algunas estadísticas.



## 2. Descripción

Este proyecto contiene uan librería que es capaz de analizar archivos y directorios, seleccionando a los archivos que su extención sea **markdown** (.md), y extrae los links que contenga para hacerles una serie de verificaciones con estadísticas.


## 3. Diagrama de flujo

El siguiente [Diagrama de flujo](https://miro.com/app/board/uXjVMHqQnGA=/?share_link_id=701567099394) perimite visualizar el orden en el que el proyecto se fue haciendo para generar la librería. 

## 4. Modo de uso

### Instalación
La librería se instala con el siguiente comando desde el terminal: `npm i md-links-laumontero` 

### Ejecución
La librería se ejecuta desde la terminal:  
`md-links-laumontero <ruta archivo> [options]`


### Ejemplo, si se ejecuta sin opciones: 
 `$ md-links-laumontero ./ruta/example.md`

Debe salir

```sh
Texto: Link a algo
Url: http://ejemplo.com/
File:  ./ruta/example.md 
```


### Ejemplo, si se ejecuta con opción --validate: 
`$ md-links-laumontero ./ruta/example.md --validate`

Debe salir

```sh
Texto: Link a algo
Url: http://ejemplo.com/
File:  ./ruta/example.md 
Status: 200 o 404
Message: 'OK' O 'Not Found'
```

### Ejemplo, si se ejecuta con opción --stats: 
`$ md-links-laumontero ./ruta/example.md --stats`

Debe salir

```sh
Total: (cantidad de links encontrados)
Unique: (cantidad de links encontrados y que no se repiten)
```

### Ejemplo, si se ejecuta con opciones --validate --stats: 
`$ md-links-laumontero ./ruta/example.md --validate --stats`

Debe salir

```sh
Total: (cantidad de links encontrados)
Broken: (cantidad de links que no funcionan)
Unique: (cantidad de links encontrados y que no se repiten)
```

## 5. Desplegado en NPM

[NPM](https://www.npmjs.com/package/md-links-laumontero)

---
_Source: https://npm.io/package/md-links-laumontero · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._