Markdown é uma linguagem de marcação
muito popular entre os programadores. É usada em diversas 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 foi 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 estatísticas que nele existem.
Instale a biblioteca no terminal através do comando: npm install jessicazanon-mdlinks
Após a instalação, certifique de ter um arquivo .md com links dentro.
1. Rode o comando `mdlinks` + o caminho do seu arquivo e será retornado o text, o link e o arquivo. Veja o exemplo abaixo: ![mdLinks](./src/imagensMd/caminho%20do%20arquivo.png)
-
Se você deseja validar os links desses arquivos, utilize a propriedade --validade, esta fará uma requisição HTTP e retornará o status e o ok do seu link. Indicando se o link é válido ou falho.
Comando:md-links <caminho-do-arquivo> --validate
Veja o exemplo abaixo:
-
Se você deseja verificar as estatísticas dos links desse arquivo, utilize a propriedade --stats, esta retornará o total de links encontrados no arquivo e quais desses são únicos.
Comando:md-links <caminho-do-arquivo> --stats
Veja o exemplo abaixo:
-
Se você deseja verificar as estatísticas e validar os links desse arquivo, utilize a propriedade --validade --stats, estas retornarão o total de links encontrados no arquivo, quais desses são únicos e quais estão quebrados.
Comando:md-links <caminho-do-arquivo> --validate --stats
Veja o exemplo abaixo:
Fluxograma do projeto