# naterayc-md-links

> md-links

Latest version **0.1.16** (published 2020-11-23) · ISC license · 0 weekly downloads

## Install

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

Provides the command `naterayc-mdlinks`.

## 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.16 |
| Published | 2020-11-23 |
| First published | 2020-11-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 27.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yndira Natera |
| Maintainers | naterayc |

## Links

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

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^16.1.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Recent versions

- 0.1.16 (latest) — 2020-11-23
- 0.1.15 — 2020-11-23
- 0.1.14 — 2020-11-23
- 0.1.13 — 2020-11-22
- 0.1.1-2.3 — 2020-11-22
- 0.1.1-2.2 — 2020-11-22
- 0.1.1-2.1 — 2020-11-22
- 0.1.12 — 2020-11-22
- 0.1.11 — 2020-11-20
- 0.1.10 — 2020-11-20
- 0.1.9 — 2020-11-19
- 0.1.8 — 2020-11-19
- 0.1.7 — 2020-11-19
- 0.1.6 — 2020-11-19
- 0.1.5 — 2020-11-19
- … 5 more at https://npm.io/package/naterayc-md-links/versions

## README

# Markdown Links

[Markdown](https://es.wikipedia.org/wiki/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.

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.

![md-links](https://user-images.githubusercontent.com/110297/42118443-b7a5f1f0-7bc8-11e8-96ad-9cc5593715a6.jpg)

## 2. Instrucciones de Uso

### Instalación

~~~
$ npm i naterayc-md-links
~~~
~~~
$ npm i --g naterayc-md-links
~~~

### CLI

Md-links retornara todos los links que encuentre.

Pasándole un archivo extension .md :
~~~
$ naterayc-mdlinks ./archivo.md
./archivo.md https.tulink.com tu link
./archivo.md https.linkaalgo.com link a algo
~~~
Pasándole un directorio :
~~~
$ naterayc-mdlinks ./
./archivo.md https.tulink.com tu link
./archivo.md https.linkaalgo.com link a algo
~~~

MdLinks tambien recibe Options:

### Validate (--validate || --v)
Realiza una petición http a cada link que encuentre e imprime el estado de la respuesta.
~~~
$ naterayc-mdlinks ./archivo.md --v
./archivo.md https.tulink.com tu link 200 OK!
./archivo.md https.linkaalgo.com link a algo 404 FAIL
~~~

### Stats (--stats || --s)
Imprimirá la cantidad total de links encontrados, y la cantidad de links únicos.

~~~
$ naterayc-mdlinks ./archivo.md --s
Total: 2
Unique: 2
~~~

### Validate + Stats
Imprimirá el total de links encontrados, la cantidad de links únicos y el número de links rotos.

~~~
$ naterayc-mdlinks ./archivo.md --s --v
Total: 2
Unique: 2
Broken: 0
~~~

## Módulo
MdLinks tambien puede ser requerido como un módulo. E imprimira un array de objetos con todos los links encontrados.

~~~js
const mdLinks = require('naterayc-md-links/md-links');
mdLinks("./archivo.md")
.then(data => {
    .....
})
~~~

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