# md-links-renata-ribeiro

> Leitor de arquivos .md executado no nodejs

Latest version **0.1.1** (published 2023-07-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install md-links-renata-ribeiro
pnpm add md-links-renata-ribeiro
yarn add md-links-renata-ribeiro
bun add md-links-renata-ribeiro
```

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.1 |
| Published | 2023-07-25 |
| First published | 2023-07-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.x |
| Dependencies | 9 |
| Unpacked size | 134.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Renata Ribeiro |
| Maintainers | rbcribeiro |
| Keywords | markdown, nodejs, arquivos md |

## Links

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

## Dependencies (9)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [init](https://npm.io/package/init.md) ^0.1.2
- [node](https://npm.io/package/node.md) ^20.2.0
- [test](https://npm.io/package/test.md) ^3.3.0
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [marked](https://npm.io/package/marked.md) ^5.1.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.1
- [marked-mangle](https://npm.io/package/marked-mangle.md) ^1.0.1
- [marked-gfm-heading-id](https://npm.io/package/marked-gfm-heading-id.md) ^3.0.4

## 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) — 2023-07-25

## README

<div align="center">

# Markdown Links 



Bem-vindo ao MdLinks! Esta é uma biblioteca para ler e extrair links de arquivos [Markdown](https://docs.pipz.com/central-de-ajuda/learning-center/guia-basico-de-markdown#open) e validar a disponibilidade desses links. <br>
  #### Status do projeto: `Em progresso...`
  <img src="./icon-md.png" alt="Markdown Links" width="60" height="60">
  </div>






## Índice

- [Sobre o Projeto](#sobre-o-projeto)
- [Instalação](#instalação)
- [Utilização](#como-utilizar)
- [Objetivos alcançados](#objetivos-alcançados)
- [Tecnologias Utilizadas](#tecnologias-utilizadas)
- [Considerações Finais](#considerações-finais)
- [Desenvolvedora](#desenvolvedora)



## Sobre o Projeto

O objetivo deste projeto é facilitar a extração de links contidos em arquivos Markdown e fornecer informações adicionais, como a validação da disponibilidade dos links. É uma ferramenta útil para quem trabalha com projetos em Markdown e precisa verificar a integridade dos links.

## Instalação

Para utilizar esta biblioteca, é necessário instalá-la via npm. Abra o terminal e execute o seguinte comando:

```
npm i md-links-renata-ribeiro
```



## Utilização

Esta biblioteca pode ser utilizada através da linha de comando (CLI). Após a instalação global, o executável `md-links` estará disponível no path do seu sistema. Você pode usá-lo da seguinte forma:

```
md-links <caminho-do-arquivo-ou-diretório>
```

Opções disponíveis:

- `--validate`: Verifica a disponibilidade dos links encontrados.

<div align="center"><img src="./img/validate.JPG" width="500" /> </div>

- `--stats`: Exibe estatísticas sobre os links encontrados, como total e únicos.

<div align="center"><img src="./img/stats.JPG" width="500"/></div>

- `-- validate --stats`: Exibe estatísticas sobre os links encontrados, como total, únicos e quebrados.

<div align="center"><img src="./img/validate_stats.JPG" width="500"/></div>

- `Sem definir opção(validate/stats)`: Exibe informações como o diretório, texto e links encontrados

<div align="center"><img src="./img/sem_opcao.JPG" width="500"/></div>

### Exemplos de uso:

Para inspecionar o arquivo digite o nome com extensão md:
```
md-links ./arquivo.md --validate --stats
md-links ./arquivo.md --validate
md-links ./arquivo.md --stats
md-links ./arquivo.md 
```
Para inspecionar um diretório:
```
md-links ./pasta-de-arquivos --validate --stats
md-links ./pasta-de-arquivos --validate
md-links ./pasta-de-arquivos --stats
md-links ./pasta-de-arquivos
```
Caso seja fornecido o caminho de um diretório ele retornará a validação/status dos links referente a todos os arquivos markdown encontrados.

## Objetivos alcançados

- Ler um arquivo Markdown e buscar por links.
- Descobrir a extensão de um arquivo, no caso .md .
- Obter o conteúdo de um diretório e filtrar apenas os arquivos Markdown utilizando a extensão obtida.
- Utilização de rota relativa para acessar pastas e arquivos.
- Criar promessas para processar os links de forma assíncrona.
- Implementar a CLI para interagir com a biblioteca via linha de comando.
- Biblioteca foi testada com casos de uso variados, garantindo a eficiência do código.

## Tecnologias Utilizadas

- ` JavaScript` - Linguagem utilizada para desenvolvimento;
- ` Git` - Sistema para controlar o histórico de alterações de arquivos;
- `GitHub` -Hospedagem em nuvem para armazenar o repositório do projeto;
- `GitHub Projects` - Ferramenta utilizada para planejamento e organização;
- `VSCode` - Editor de código utilizado para desenvolvimento do projeto;
- `Node.js` - Um ambiente de execução do JS utilizado para rodar a biblioteca;
- `Lucidchart` - Ferramenta utilizada para criar o fluxograma do projeto.


## Considerações Finais

Espero que esta biblioteca seja útil para você em seus projetos Markdown. Caso encontre algum bug ou tenha sugestões de melhoria, fique à vontade para abrir uma issue no repositório do projeto. Sua contribuição é muito bem-vinda!


<div align="center">

### Desenvolvedora

#### Renata Ribeiro

[![Github](https://img.shields.io/badge/-Github-000?style=flat-square&logo=Github&logoColor=white&link)](https://github.com/rbcribeiro) [![Linkedin](https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white&link)](https://www.linkedin.com/in/rbcribeiro) 
</div>

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