# @jessira/md-links

> Search and validate links in markdown files

Latest version **0.1.3** (published 2022-05-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install @jessira/md-links
pnpm add @jessira/md-links
yarn add @jessira/md-links
bun add @jessira/md-links
```

Provides the command `md-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 | 2022-05-13 |
| First published | 2022-05-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.x |
| Dependencies | 7 |
| Unpacked size | 248.9 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jessica Sierra |
| Maintainers | jessira |
| Keywords | cli, api, node, links, markdown |

## Links

- npm: https://www.npmjs.com/package/@jessira/md-links
- Repository: https://github.com/Jessica9326/BOG004-md-links
- Homepage: https://github.com/Jessica9326/BOG004-md-links#readme
- Issues: https://github.com/Jessica9326/BOG004-md-links/issues
- npm.io page: https://npm.io/package/@jessira/md-links

## Dependencies (7)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [jsdom](https://npm.io/package/jsdom.md) ^19.0.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [marked](https://npm.io/package/marked.md) ^4.0.14
- [chalk-table](https://npm.io/package/chalk-table.md) ^1.0.2
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^26.1.5

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2022-05-13
- 0.1.2 — 2022-05-10
- 0.1.1 — 2022-05-08
- 0.1.0 — 2022-05-08

## README

# MD LINK

![Md- Links](./MD-LINKS.png)

## 1. Preámbulo

[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`).

### 2. MD-LINKS

Librería utilizada para validar la disponibilidad de los links presentes en archivos MD dentro de un directorio.

### 3. Instalación

```sh
npm install @jessira/md-links
```

#### 4. Uso a travez de la terminal

Se ejecuta a través de la terminal de la siguiente manera:

```sh
md-links "./some/example.md"
```

Esto dara como respuesta las propiedades de la url:

* `href`: URL encontrada.
* `text`: Texto que aparecía dentro del link (`<a>`).
* `file`: Ruta del archivo donde se encontró el link.

## Opciones

```sh
md-links "./some/example.md [opciones]"
```

### --validate

El módulo hace una petición HTTP para averiguar si el link funciona

```sh
$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google
```

### --stats

Texto con estadísticas básicas sobre los links.

```sh
$ md-links ./some/example.md --stats
Total: 3
Unique: 3
```

### --stats y --validate

Para adicionar a la estadistica, los links rotos

```sh
$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1
```

### ---help

Obtendra mayor información sobre las opciones

### Para uso prográmatico

```sh
const mdLinks = require("@jessira/md-links");
```

```sh
mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }, ...]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }, ...]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }, ...]
  })
  .catch(console.error);
```

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