Markdown Links

Índice

• 1. Prefácio
• 2. Guia de instalação e uso
• 3. Funcionalidades da Biblioteca
• 4. Fluxograma
• 5. Tecnologias Utilizadas
• 6. Colaboradores

---

1. Prefácio

Markdown é uma linguagem de marcação muito popular entre os programadores. É usada em muitas plataformas que manipulam texto (GitHub, fórum, blogs e etc) e é muito comum encontrar arquivos com este formato em qualquer repositório (começando pelo tradicional README.md).

O Objetivo deste projeto é desenvolver uma biblioteca que lê arquivos Markdown através de uma CLI (command-line interface) que possiblita a execução da biblioteca no terminal, a partir de um módulo do Node.js, no qual, este irá fazer a leitura dos arquivos em formato Markdown('.md'), verificando a existência de links e estatisticas que nele existem.

2. Guia de instalação e uso

2.1 Instalação

Para instalar a biblioteca, utilize o gerenciador de pacotes npm. No terminal, execute o seguinte comando:

npm install https://github.com/roxanevp/SAP010-md-links.git

2.2 Utilização

Após a instalação, você poderá utilizar o Markdown Links através da CLI, basta executar o seguinte comando:

mdlinks <caminho-do-arquivo> [--validate] [--stats]

Como:

< caminho-do-arquivo > : O caminho para o arquivo .md que deseja analisar.
--validate: (Opcional) Realiza a validação dos links, exibindo o status de cada link (ativo ou quebrado).
--stats: (Opcional) Exibe estatísticas dos links, como o total de links e links únicos. Exemplo:

3. Funcionalidades da Biblioteca

O Markdown Links oferece as seguintes funcionalidades:

3.1 Extração de Links

A biblioteca é capaz de ler um arquivo .md e extrair os links presentes nele. Os links são identificados pelo formato [texto] (url).

3.2 Validação de Links

Utilizando a opção --validate na CLI, a biblioteca realizará uma requisição HTTP para cada link encontrado a fim de verificar se estão ativos ou quebrados. Os links ativos terão o status "ok" e os quebrados terão o status "fail".

3.3 Estatísticas de Links

Utilizando a opção --stats na CLI, a biblioteca exibirá estatísticas sobre os links encontrados no arquivo. Será exibido o total de links e a quantidade de links únicos.

3.4 Validação e Estatísticas de Links

Utilizando as opções --validate --stats na CLI, a biblioteca exibirá tanto as estatísticas quanto a validação dos links encontrados.

4. Fluxograma

Também usado o GitHub Projects para o planejamento de cada etapa dentro dos marcos acima do projeto.

5. Tecnologias Utilizadas

6. Colaboradores

_{Roxane Príncipe}