# sandymarmolejo-md-links

> Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, etc), y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio.

Latest version **1.0.3** (published 2020-09-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install sandymarmolejo-md-links
pnpm add sandymarmolejo-md-links
yarn add sandymarmolejo-md-links
bun add sandymarmolejo-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.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-09-14 |
| First published | 2020-09-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 165.1 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | sandymarmolejo |

## Links

- npm: https://www.npmjs.com/package/sandymarmolejo-md-links
- Repository: https://github.com/SandyMarmolejo/LIM012-fe-md-links
- Homepage: https://github.com/SandyMarmolejo/LIM012-fe-md-links#readme
- Issues: https://github.com/SandyMarmolejo/LIM012-fe-md-links/issues
- npm.io page: https://npm.io/package/sandymarmolejo-md-links

## Dependencies (13)

- [jest](https://npm.io/package/jest.md) ^25.4.0
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [eslint](https://npm.io/package/eslint.md) ^6.0.1
- [marked](https://npm.io/package/marked.md) ^1.0.0
- [valid-url](https://npm.io/package/valid-url.md) ^1.0.9
- [babel-core](https://npm.io/package/babel-core.md) ^7.0.0-bridge.0
- [babel-jest](https://npm.io/package/babel-jest.md) ^24.8.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.2.2
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^22.1.2
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.18.2
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^13.2.0
- [@babel/plugin-transform-modules-commonjs](https://npm.io/package/@babel/plugin-transform-modules-commonjs.md) ^7.2.0

## Recent versions

- 1.0.3 (latest) — 2020-09-14
- 1.0.2 — 2020-09-14

## README

# Md Links

## Información General
Markdown es un lenguaje de marcado
ligero muy popular entre developers. Es usado en muchísimas plataformas que
manejan texto plano (GitHub, foros, blogs, etc), y es muy común
encontrar varios archivos en ese formato en cualquier tipo de repositorio. 
(Ejemplo: README.md).

Estos archivos Markdown normalmente contienen _links_ 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.

`Md links` es una herramienta que usa Node.js, para leer y analizar archivos en formato Markdown, para verificar los links contenidos y reportar algunas estadísticas.

## Instalación

```
npm i sandymarmolejo-md-links --save
```

## Usos


```js
const mdLinks = require("md-links");

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);
```

## Opciones

MdLink tiene 2 opciones, ambas son opcionales y pueden usarse juntas también:

##### `--validate`

Si pasamos la opción `--validate`, el módulo debe hacer una petición HTTP para
averiguar si el link funciona o no, incluye la palabra `ok` o `fail` después de
la URL, así como el status de la respuesta recibida a la petición HTTP a dicha
URL.

Por ejemplo:

<img src="Imagenes guia de uso\opcion validate.png">

##### `--stats`

Si pasamos la opción `--stats` el output (salida) será un texto con estadísticas
básicas sobre los links.

Por ejemplo:

<img src="Imagenes guia de uso\opcion stats.png">

##### `--stats` y `--validate`

También podemos combinar las opciones para obtener estadísticas que
necesiten de los resultados de la validación.

Por ejemplo:

<img src="Imagenes guia de uso\opcion validate y stats.png">


### CLI (Command Line Interface - Interfaz de Línea de Comando)

Al colocar md-links en la terminal y --help se muestra el mensaje de bienvenida y las opciones que puedes escoger.

Por ejemplo:

<img src="Imagenes guia de uso\help.png">

Si no se ingresa ninguna ruta ni alguna de las opciones, se mostrará un mensaje de opción inválida y te volverá a mostar el mensaje de bienvenida y las opciones que puedes escoger.

<img src="Imagenes guia de uso\no se ingresa ninguna opcion ni ruta.png">

`md-links <path-to-file> [options]`

Por ejemplo:

<img src="Imagenes guia de uso\solo ruta.png">

Por default identifica el archivo markdown (a partir de la ruta que recibe como
argumento), analiza el archivo Markdown e imprimir los links que vaya
encontrando, junto con la ruta del archivo donde aparece y el texto
que hay dentro del link.

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