# npm-links

> * [1. Preámbulo](#1-preámbulo) * [2. Resumen del proyecto](#2-resumen-del-proyecto) * [3. Objetivos de aprendizaje](#3-objetivos-de-aprendizaje) * [4. Consideraciones generales](#4-consideraciones-generales) * [5. Criterios de aceptación mínimos del p

Latest version **1.0.1** (published 2022-06-16) · ISC license · 0 weekly downloads

## Install

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

Provides the command `md-links`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-06-16 |
| First published | 2022-06-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.x |
| Dependencies | 4 |
| Unpacked size | 233.7 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | thaliaroman |

## Links

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

## Dependencies (4)

- [jsdom](https://npm.io/package/jsdom.md) ^19.0.0
- [cli-color](https://npm.io/package/cli-color.md) ^2.0.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7
- [markdown-it](https://npm.io/package/markdown-it.md) ^13.0.1

## Recent versions

- 1.0.1 (latest) — 2022-06-16
- 1.0.0 — 2022-06-12

## README

# Markdown Links

## Índice

* [1. Preámbulo](#1-preámbulo)
* [2. Resumen del proyecto](#2-resumen-del-proyecto)
* [3. Diagrama de flujo](#3-diagrama-de-flujo)
* [4. Instalación](#4-instalacion)
* [5. Instrucciones](#5-instrucciones)
* [6. Autor](#6-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.
## 2. Resumen del proyecto

`.md Links` es una herramienta de línea de comando (CLI) que se ejecuta en Node.js

`.md Links` va a leer y analizar archivos en formato markdown, para verificar los links que contengan y reportar algunas estadísticas.

![mdLinks](./images/mdLinks.png)


## 3. Diagrama de flujo
Este es el digrama de flujo que se creó como punto de partida para empezar a construir `.md Links`, aquí el usuario tendrá mejor idea del trabajo interno que hará la librería despues de ingresar alguna ruta y opciones

![flujograma](./images/flujograma-md-links-thaliaroman.jpg)


## 4. Instalación
Para la instalar  `.md Links` el usuarios debe ejecutar la siguiente línea de comando en tu terminal:

`npm i npm-links`

## 5. Instrucciones
con `.md Links` el usuario va a poder escribir diferentes argumentos o comandos en la terminal para obtener la información requerida. Va a poder trabajar con rutas y opciones.

5.1. Ingresando  md-links `path` , obtendrá por cada link encontrado:
`link` `texto del link`
`ruta absoluta donde se encontró el link`

Por ejemplo :
![ejemplo con path](./images/path.jpeg)

5.2. Ingresando md-links `path` y la opción `--validate`, obtendrá por cada Link encontrado:
`link` `texto del link`
`ruta absoluta donde se encontró el link`
`status del link` `mensaje ok , o de error si el link está roto`

Por ejemplo :
![ejemplo con path y validate](./images/path--validate.jpeg)

5.3. Ingresando md-links `path` y la opción `--stats`, obtendrá:
`total de liks encontrados`
`total de links únicos`

Por ejemplo :
![ejemplo con path y stats](./images/path--stats.jpeg)

5.4. Ingresando md-links `path` y las opciones `stats` y `--validate` obtendrá:
`total de liks encontrados`
`total de links únicos`
`total de liks rotos`

por ejemplo :
![ejemplo con path y stats](./images/path--validate--stats.jpeg)

## 6. Autor

Thalia Román López

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