Md-links-geanemr NPM

Markdown Links

Índice

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).

2. Resumo do projeto

Os arquivos Markdown normalmente contém links que podem estar quebrados, ou que já não são válidos, prejudicando muito o valor da informação que está ali.

Pensando nisso, foi criado o projeto Md-links, com o objetivo de percorrer estes arquivos markdown, retornando as listas de links, textos e caminhos dos respectivos arquivos, além de informar quantos links de extensão .md esses arquivos possuem, se são únicos e se estão quebrados ou não.

3. Guia de instalação

Para instalar esta biblioteca você deve executar a seguinte linha de comando: npm install md-links-geanemr. Após a instalação, certifique de ter um arquivo .md com links dentro.

4. Guia de uso

a) Rode o comando mdlinks + o caminho relativo do seu arquivo , para obter os links dos arquivos (href), os textos (text) e os caminhos (file) dos mesmos:

md-links <caminho-do-arquivo>

b) Rode o comando abaixo para, além das informações acima, fazer uma requisição HTTP e receber o status e ok dos seus links:

md-links <caminho-do-arquivo> --validate

c) Você também pode receber informações estatísticas sobre os links. Rode o comando abaixo para saber qual o total de links do arquivo e quantos deles são únicos:

md-links <caminho-do-arquivo> --stats

d) E, para saber quantos destes arquivos únicos estão quebrados, rode o comando abaixo:

md-links <caminho-do-arquivo> --validate --stats