# the-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 **0.1.3** (published 2019-09-09) · ISC license · 0 weekly downloads

## Install

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

Provides the commands `--stats`, `--validate`, `viri-links`.

## 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.3 |
| Published | 2019-09-09 |
| First published | 2019-08-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 361.8 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | viriavemed |

## Links

- npm: https://www.npmjs.com/package/the-links
- Repository: https://github.com/ViriAvemed/MEX008-FE-md-link
- Homepage: https://github.com/ViriAvemed/MEX008-FE-md-link#readme
- Issues: https://github.com/ViriAvemed/MEX008-FE-md-link/issues
- npm.io page: https://npm.io/package/the-links

## Dependencies (4)

- [request](https://npm.io/package/request.md) ^2.88.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^9.1.0

## Recent versions

- 0.1.3 (latest) — 2019-09-09
- 0.1.2 — 2019-09-09
- 0.1.1 — 2019-09-09
- 0.1.0 — 2019-08-29

## README

# Markdown Links

Este modulo fue diseñado con la finalidad de encontrar los links existentes en los archivos markdown
y poder verificar si siguen vigentes.



## Funcionamiento
The-links sigue la lógica del siguiente diagrama de flujo.

![Diagrama](img/mdLinks.png)

## Instalación

Para instalar la dependencia en tu proyecto debes ejecutar el siguiente comando desde tu consola .

```sh
 $ npm i the-links
 ``` 

## Funcionamiento Interfaz de Línea de Comando)

* Ruta sin opciones

Para poder ejercutar the-links debes ingresar el siguiente comando seguido por la ruta relativa o absoluta del
archivo tipo .md que quieres revisar. Está ejecución imprimirá todos los links encontrados.

```sh

$ viri-links ./some/example.md

```
![viri-links](img/comando1.PNG)

* Ruta con opción validate

Para conocer si los links de un archivo siguen vigentes o se han roto, debes ingresar el siguiente comando
el cual imprimirá todos los links y en caso de seguir activos, su estatus será "Ok", de lo contrario se imprimirá "Not Found".
```sh

$ viri-links ./some/example.md validate

```
![viri-links](img/comando2.PNG)

* Ruta con opción stats

El siguiente comando imprimirá el total de links encontrados y el total de los que no se repiten.

```sh

$ viri-links ./some/example.md stats

```

![viri-links](img/comando3.PNG)

* Ruta con opción validate y stats

Para obtener los links validados y el total de los mismos debes ingresar el siguiente comando en el orden que se muestra.

```sh

$ viri-links ./some/example.md validate stats

```

![viri-links](img/amboscomandos.PNG)

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