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.
Instale a biblioteca no terminal através do comando: npm install thalita-carnicell-mdlinks
Após a instalação, certifique de ter um arquivo .md com links dentro.
-
Rode o comando
mdlinks+ o caminho do seu arquivo , e será retornado o caminho, text e o link do arquivo seleciondao. Veja o exemplo abaixo:
-
Se você deseja validar os links desse arquivo, utilize a propriedade --validade, esta fará uma requisição HTTP e retornará o status e ok do seu link.
Comando:
md-links <caminho-do-arquivo> --validate.
Veja o exemplo abaixo:
-
Se você deseja verificar as estatistiscas dos links desse arquivo, utilize a propriedade --stats, esta retornará o total de links encontrados no arquivo e quais desses são unicos.
Comando:
md-links <caminho-do-arquivo> --stats.
Veja o exemplo abaixo:
-
Se você deseja verificar as estatistiscas e validar os links desse arquivo, utilize a propriedade --validade --stats, esta retornará o total de links encontrados no arquivo, quais desses são unicos e quais estão quebrados.
Comando:
md-links <caminho-do-arquivo> --validate --stats.
Veja o exemplo abaixo:
Fluxograma do projeto
