# md-links-k-garrido

> Libreria desarrollada para extraer los links de los archivos Markdown y verificar su estado

Latest version **0.1.1** (published 2021-06-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install md-links-k-garrido
pnpm add md-links-k-garrido
yarn add md-links-k-garrido
bun add md-links-k-garrido
```

Provides the command `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.1 |
| Published | 2021-06-14 |
| First published | 2021-06-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 191.5 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Katherinne Fernanda Garrido Lopez |
| Maintainers | k-garrido |
| Keywords | mdLinks |

## Links

- npm: https://www.npmjs.com/package/md-links-k-garrido
- Repository: https://github.com/k-garrido/SCL016-md-link
- Homepage: https://github.com/k-garrido/SCL016-md-link#readme
- Issues: https://github.com/k-garrido/SCL016-md-link/issues
- npm.io page: https://npm.io/package/md-links-k-garrido

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^2.0.7
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2021-06-14
- 0.1.0 — 2021-06-13

## README

# Markdown Links 

 Esta librería te permitirá analizar tus archivos `Markdown` para extraer sus links, verificar su estado o entregar estadísticas.

## Instalación
 Para instalar este módulo debes ingresar el siguiente código en la terminal:

```sh
npm install https://github.com/k-garrido/SCL016-md-link
```
## Implementación
### Uso en la línea de comando de la terminal

El usuario puede realizar las siguientes acciones desde la terminal 	
*	Ver links del archivo MD

    Esta opción te  permitirá extraer los links de tu archivo .md y mostrar información detallada en un array de objetos, donde cada objeto será representado por un link y contendrá las siguientes propiedades: 

    - HREF: Mostrara el URL.

    - Text: Mostrara el texto que  había dentro del ancla.

    - File: Mostrara la ruta  del archivo  en donde se encontró ese link.

  Para poder  utilizar esta opción debes ingresar en la terminal lo siguiente:

```sh
mdLinks + la ruta de tu archivo o directorio
```
Como se muestra en la siguiente imagen:

<img src="./imagesReadme/1.png" alt="paper-image" width="500"/>

*	--validate:

    Esta opción ejecutara una petición HTTP por cada link y nos especificara si el link es válido o no. Si se ejecuta la petición correctamente se agregaran 2 secciones en nuestro objeto de arrays, el primero es “status” el cual nos  mostrara el código 200  si el link es válido o 404 si el link es invalido y el segundo es “statusText” el cual nos mostrara un OK o FAIL en caso de que el link funcione correctamente o no.

  Para poder  utilizar esta opción debes ingresar en la terminal lo siguiente:


```sh
mdLinks + la ruta de tu archivo o directorio + --validate
```
Como se muestra en la siguiente imagen:

<img src="./imagesReadme/2.png" alt="paper-image" width="500"/>

*	--stats

    Esta opción nos mostrara una pequeña tabla  la cual nos mostrara la siguiente información:

	- Unique: Mostrara cuantos links únicos existen en el archivo .md.

	- Total: Mostrara el total de links en el archivo .md.

  Para poder  utilizar esta opción debes ingresar en la terminal lo siguiente:

```sh
mdLinks + la ruta de tu archivo o directorio + --stats
```
Como se muestra en la siguiente imagen:

<img src="./imagesReadme/3.png" alt="paper-image" width="500"/>

* --validate –stats:

   Esta opción nos motrara una tabla con la siguiente información: 

  - Total: Mostrara el total de links en el archivo .md.
  - Unique: Mostrara cuantos links únicos existen en el archivo .md.
  - Broken: Mostrara la cantidad de links que no están funcionando correctamente.

Para poder  utilizar esta opción debes ingresar en la terminal lo siguiente:

```sh
mdLinks + la ruta de tu archivo o directorio + --validate + --stats
```
Como se muestra en la siguiente imagen:

<img src="./imagesReadme/4.png" alt="paper-image" width="500"/>

### Uso de la api 

Para poder usar md-links en tu proyecto primero debes importar el módulo de la siguiente manera:

```sh
Const mdLinks = require(‘md-links’);
```
Luego puedes llamar a nuestra función junto con sus argumentos, como se muestra a continuación:

```sh
mdLinks.md.mdLinks(path,options);
```

-- Path es la ruta a tu archivo o directorio

-- Las opciones pueden ser {validate:true} o {validate:false}

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