# @mariilo97/md-links

> * [1. Resumen](#1-Resumen) * [2. Como instalarlo](#2-Como-instalarlo) * [3. Como utilizarlo](#3-Como-utilizarlo) * [4. Apoyo personal](#4-Apoyo-personal)

Latest version **0.1.0** (published 2023-06-14) · 0 weekly downloads

## Install

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

Provides the command `mdLinksMl`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-06-14 |
| First published | 2023-06-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM |
| Node | >=16.x |
| Dependencies | 1 |
| Unpacked size | 192.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | mariilo97 |

## Links

- npm: https://www.npmjs.com/package/@mariilo97/md-links
- npm.io page: https://npm.io/package/@mariilo97/md-links

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.4.0

## Recent versions

- 0.1.0 (latest) — 2023-06-14

## README

# Markdown Links

## Índice

* [1. Resumen](#1-Resumen)
* [2. Como instalarlo](#2-Como-instalarlo)
* [3. Como utilizarlo](#3-Como-utilizarlo)
* [4. Apoyo personal](#4-Apoyo-personal)

***

## 1. Resumen

Markdown Links, proyecto totalmente pensado para que el usuario pueda hacer una revision valida de los enlaces de sus archivos MD, esto con la intención de conocer a través de la estadistica de los mismos la cantidad de links que emiten alguna especie de falla o que definitivamente se encuentran en buen estado. 

Este programa escrito con vanilla JavaScript y utilizando la aplicación Node.js. 

## 2. Como instalarlo

+++++++++++++++++++++++

## 3. Como utilizarlo 

API

La funcion mdLinksMl que le da vida a la Api contienes las siguientes opciones. 

validate:false
Nos entregara el arreglo de tres objetos = link: URL encontrada.
                                           text: Texto que aparecía dentro del link ().
                                           href: Ruta del archivo donde se encontró el link.

validate:true
Nos entregará el arreglo de cinco objetos = link: URL encontrada.
                                            text: Texto que aparecía dentro del link ().
                                            href: Ruta del archivo donde se encontró el link.
                                            status: Código de respuesta HTTP.
                                            statusText: Mensaje 'Fail 😒' en caso de rechazo, Mesaje 'OK👍' en caso de éxito.

CLI

Compuesta por su parametros 
Route: Ruta absoluta o Ruta relativa y convertida en absoluta. 
Option: --validate = modulo que crea la peticion HTTP y valida que sea un links funcional. 
        --stats = arroja la estadistica básica del links, *Total y *Unique
        --validate --stats = arroja estadisticas y validación, *Total, *Unique y *Broken.

## 4. Apoyo personal

Creamos el diagrama de flujo con la intencion de guiarnos en todo momento para la realización completa de este proyecto. 

*Diagrama de flujo de Api. Creamos la funcion mdLinksMl y en esta viviran pequeñas funciones para su total uso. 

 ![APIDiagramaDeFlujo](C:/Users/MARY LOPEZ\DEV004-md-links/API-Diagrama de flujo..png)

*Diagrama de flujo de Cli. Damos vida a cada "option" y determinamos su llamada por comando.

 ![CLIDiagramaDeFlujo](C:/Users/MARY LOPEZ/DEV004-md-links/CLI-Diagrama de flujo!.png)

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