# md-links-cristyna

> Extração e verificação de links dentro de arquivos .md

Latest version **1.0.0** (published 2023-08-10) · 0 weekly downloads

## Install

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

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.0 |
| Published | 2023-08-10 |
| First published | 2023-08-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.x |
| Dependencies | 6 |
| Unpacked size | 248.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Cristyna Costa |
| Maintainers | cristynabc |

## Links

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

## Dependencies (6)

- [-](https://npm.io/package/-.md) ^0.0.1
- [g](https://npm.io/package/g.md) ^2.0.1
- [axios](https://npm.io/package/axios.md) ^1.4.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^3.0.1
- [@jest/globals](https://npm.io/package/@jest/globals.md) ^29.6.1

## Recent versions

- 1.0.0 (latest) — 2023-08-10
- 0.1.4 — 2023-08-07
- 0.1.3 — 2023-08-02
- 0.1.2 — 2023-08-02
- 0.1.1 — 2023-08-02
- 0.1.0 — 2023-08-02

## README

# MD-LINKS
## 1. Introdução
O **MD-Links** é uma ferramenta de linha de comando (CLI) desenvolvida utilizando NodeJS que permite extrair links de arquivos Markdown (.md) e fornecer informações úteis sobre eles. Com essa ferramenta, você pode facilmente verificar a validade dos links e obter estatísticas sobre o número de links presentes nos arquivos.

## 2. Funcionalidades
- Extrai links de arquivos Markdown (.md).
- Verifica o status HTTP dos links através da opção `--validate`.
- Fornece estatísticas sobre os links presentes nos arquivos utilizando a opção `--stats`.
- Combinando as opções `--stats` e `--validate`, você obtém estatísticas detalhadas, incluindo o número total de links, quantos são únicos e quantos estão quebrados.

## 3. Guia de instalação e uso
### 3.1 Pré-requisitos
- Node.js
- NPM 

### 3.2 Instalação
1. Abra o terminal
2. Execute o seguinte comando para instalar o MD-Links globalmente:
```bash
npm install -g md-links-cristyna
```
### 3.3 Uso

**1. Para extrair links de um arquivo Markdown:**
```bash
md-links caminho/do/arquivo.md
```
**Exemplo de resultado:** 

![Extrair links](<img/Captura de Tela 2023-08-07 às 19.29.26.png>)

**2. Para extrair e verificar o status HTTP dos links:**

```bash
md-links caminho/do/arquivo.md --validate
``` 
**Exemplo de resultado:** 

![Links validate](<img/Captura de Tela 2023-08-07 às 19.29.09.png>)

**3. Para obter estatísticas sobre os links:**

```bash
md-links caminho/do/arquivo.md --stats
``` 
**Exemplo de resultado:** 

![Link stats](<img/Captura de Tela 2023-08-07 às 19.28.28.png>)

**4. Para obter estatísticas e validar os links:**

```bash
md-links caminho/do/arquivo.md --stats --validate
``` 
**Exemplo de resultado:** 

![Link validate and stats](<img/Captura de Tela 2023-08-07 às 19.28.41.png>)

## 4. Tecnologias utilizadas
![JAVASCRIPT ICON](https://skillicons.dev/icons?i=js,nodejs,jest,git,vscode)

## 4. Desenvolvedora

### Cristyna Becker Costa 

cristynabcosta@gmail.com

[![LINKEDIN ICON](https://skillicons.dev/icons?i=linkedin)](https://www.linkedin.com/in/cristyna-becker-costa/)
[![GITHUB ICON](https://skillicons.dev/icons?i=github)](https://github.com/CristynaBC)

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