# pipz-md-links

> CLI tool that help you to search links

Latest version **0.1.0** (published 2023-08-09) · 0 weekly downloads

## Install

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

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.0 |
| Published | 2023-08-09 |
| First published | 2023-08-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.x |
| Dependencies | 2 |
| Unpacked size | 26.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pía Carreño |
| Maintainers | pipz |

## Links

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

## Dependencies (2)

- [jest](https://npm.io/package/jest.md) ^29.6.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.4

## Recent versions

- 0.1.0 (latest) — 2023-08-09

## README

# Markdown Links
Check if you MD file has any links. It'll help you to see stats report and validate links found in your Markdown file.
[Developer for Laboratoria](https://github.com/Laboratoria/DEV007-md-links)

## How to use

Run in your terminal:
`mdlinks <path-to-file> [options]`

Then you'll see in the output details of all links found. Like this:
```sh
The file has the following links:
Link 1:
Text: Objetos en JavaScript
URL: https://curriculum.laboratoria.la/es/topics/javascript/05-objects/01-objects
```

You can see report stats and detaild of links found in your MD file. If you pass the [option] `--validate`, you'll see if the links works or not. 
For example, this is the way you'll see stats:
```sh
Link 2:
Text: Path
URL: https://nodejs.org/api/path.html
Status: 200
OK: Ok
```

Otherwise if you pass the [option] `--stats`, you'll see basic stats about your links. Like:
```sh
mdlinks <path-to-file> --stats
stats: { Total: 80, Unique: 75 }
```

And last, if you pass the [option] `--stats` and `--validate`, you'll see the sum of Total, Unique and Broken links.
```sh
stats and validate: { Total: 80, Unique: 75, Broken: 18 }
```

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