Extrator de Links para Arquivos Markdown

Índice

• 1. Introdução
• 2. Instalação
• 3. Funcionalidades
• 4. Fluxograma
• 5. Tecnologias Utilizadas

1. Introdução

O md-links é uma ferramenta de linha de comando (CLI) desenvolvida usando o NodeJS, criada para simplificar a extração e análise de links em arquivos Markdown (.md). Com essa ferramenta, você pode explorar a estrutura dos seus arquivos Markdown, verificar a validade dos links e obter estatísticas úteis sobre esses elementos.

Este projeto foi desenvolvido como parte do quarto desafio durante o Bootcamp da Laboratória. Ele representa não apenas a capacidade de criar software, mas também a solução para um problema real. Ao longo do desenvolvimento, foram aplicadas tecnologias modernas, como NodeJS, JavaScript e várias bibliotecas, para construir uma solução prática e versátil.

Além de melhorar as habilidades técnicas, o projeto enfatizou a importância da qualidade do código e das boas práticas de desenvolvimento. O md-links reflete o progresso e o aprendizado conquistados durante o Bootcamp.

2. Instalação

Para instalar a ferramenta, você pode utilizar o seguinte comando no terminal:

npm i md-links-diulianne

Uso

A ferramenta é utilizada da seguinte forma:

md-links <arquivo> [opções]

Exemplo:

md-links arquivo.md --validate

3. Funcionalidades

Ao usar md-links <nome do arquivo>, são fornecidas informações básicas, como nome do arquivo, texto e link.

Possui verificação do status HTTP dos links com a opção --validate.

Oferece estatísticas detalhadas dos links usando a opção --stats.

Combinando --stats e --validate, é possível obter análises detalhadas, incluindo o total de links, quantos são únicos e quantos estão quebrados.

4. Fluxograma

A seguir está o fluxograma que ilustra os diferentes fluxos do projeto:

5. Tecnologias Utilizadas