md-links-raquel-maia v0.1.0

Markdown Links

Índice

• 1. Resumo
• 2. Instalação da biblioteca
• 3. Fluxograma
• 4. Instrução de uso
• 5. Tecnologias utilizadas

1. Resumo

Markdown é uma linguagem de marcação muito popular e amplamente utilizada entre programadores e escritores online. Ela foi projetada para ser de fácil leitura e escrita, permitindo a conversão para HTML e outros formatos de apresentação.

No projeto 'Markdown Links', desenvolvido durante o bootcamp da Laboratoria, foi criada uma biblioteca em Node.js com o objetivo de ler arquivos Markdown (.md) e verificar os links contidos neles. O foco principal desse projeto foi aprimorar o conhecimento em manipulação de arquivos, trabalhar com a CLI (command-line interface) e obter estatísticas sobre os links encontrados. Com essa biblioteca, tornou-se mais simples e eficiente realizar a validação de links em arquivos Markdown."

2. Instalação da biblioteca

Para instalar a biblioteca, execute o seguinte comando no terminal:

🔹npm install md-links-raquel-maia

3. Fluxograma

4. Instrução de uso

🟣 Listagem de Links

Comando 1 > md-links ./caminhoDaPasta/nomeDoArquivo.md

Esse comando procura arquivos na rota especificada, e imprime através de uma tabela os links extraídos, juntamente com o texto descritivo do link e a rota do arquivo em que cada link foi encontrado, como o exemplo abaixo:

🟣 Validação de Links

Comando 2 > md-links ./caminhoDaPasta/nomeDoArquivo.md --validate

Esse comando fará uma requisição HTTP para verificar se cada link funciona ou não, apresentando uma tabela com o código de resposta (status HTTP) e uma mensagem correspondente em caso de sucesso (ok) ou falha (fail). Veja exemplo abaixo:

🟣 Estatísticas de links

Comando 3 > md-links ./caminhoDaPasta/nomeDoArquivo.md --stats

Esse comando --stats, exibirá em uma tabela o número total de links encontrados no arquivo e o total de links únicos.

🟣 Validação + Estatísticas de links

Comando 4 > md-links ./caminhoDaPasta/nomeDoArquivo.md --stats --validate

Esses dois comandos juntos --validate --stats exibirá em uma tabela o número total de links encontrados no arquivo, o total de links únicos, e o número total de links quebrados.

5. Tecnologias utilizadas