# md-links-danipreciado

> This is an npm package for extracting and analyzing links from Markdown files. It provides a command-line interface (CLI) tool that allows you to retrieve all the links contained in a given directory or file, and provides options for validating the status

Latest version **0.1.6** (published 2023-06-19) · ISC license · 0 weekly downloads

## Install

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

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.6 |
| Published | 2023-06-19 |
| First published | 2023-06-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.x |
| Dependencies | 3 |
| Unpacked size | 31.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | @danipreciado |
| Maintainers | danipreciado |

## Links

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

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [cfonts](https://npm.io/package/cfonts.md) ^3.2.0
- [md-links-danipreciado](https://npm.io/package/md-links-danipreciado.md) ^0.1.2

## Recent versions

- 0.1.6 (latest) — 2023-06-19
- 0.1.5 — 2023-06-15
- 0.1.4 — 2023-06-15
- 0.1.3 — 2023-06-15
- 0.1.2 — 2023-06-15
- 0.1.1 — 2023-06-14
- 0.1.0 — 2023-06-14

## README

# md-links-danipreciado

This is an npm package for extracting and analyzing links from Markdown files. It provides a command-line interface (CLI) tool that allows you to retrieve all the links contained in a given directory or file, and provides options for validating the status of each link and generating statistics about the links.

## Installation

To install the package, use the following command:


```
npm install md-links-danipreciado 
```
```
npm install danipreciado/md-links
```

To install the command line globally, run: 


``
npm install -g md-links-danipreciado 
``

## Usage

To use the md-links-cli tool, run the following command in your terminal:

```
md-links <path> [--validate] [--stats]
```

Replace `<path>` with the path to the directory or file containing the Markdown files you want to analyze.

### Options

The following options are available:

- `--validate`: Validates the status of each link.
- `--stats`: Displays basic statistics of the links.

You can use either one or both options together.

### Example

To extract and display all the links in a directory without any validation or statistics:

```
md-links /path/to/directory
```

To extract and validate the status of each link in a directory:

```
md-links /path/to/directory --validate
```

To extract and display basic statistics of the links in a directory:

```
md-links /path/to/directory --stats
```

To extract, validate, and display complex statistics of the links in a directory:

``
md-links /path/to/directory --validate --stats
``
## Output

The md-links-cli tool outputs the links found in the specified directory or file. If the `--validate` option is used, it also includes the status and message for each link. If the `--stats` option is used, it displays basic or complex statistics of the links.

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