O pacote md-links-aaf é uma ferramenta para verificar links em arquivos Markdown. Ele permite que você verifique facilmente os links contidos em seus arquivos Markdown e obtenha informações sobre eles.
Para começar a usar o md-links-aaf, você precisa tê-lo instalado no seu projeto. Para fazer isso, abra o terminal e execute o seguinte comando:
npm i md-links-aaf
Após instalar o md-links-aaf, você pode usa-lo no seu projeto da seguinte maneira:
#1- Importe o pacote:
No arquivo JavaScript do seu projeto, importe o pacote usando o require ou import, dependendo do padrão que você está usando:
const mdLinks = require('md-links-aaf'); // CommonJS
import mdLinks from 'md-links-aaf'; // ES6 Modules
#2- Chame a Função:
Use a função mdLinks para verificar os links em um arquivo Markdown:
const markdownFilePath = 'caminho/para/o/seu/arquivo.md'; Substitua pelo caminho real do arquivo .MD
mdLinks(markdownFilePath) .then(links => { // 'links' é uma lista de objetos com informações sobre os links console.log(links); }) .catch(error => { console.error('Ocorreu um erro:', error); });
O md-links-aaf suporta as seguintes opções para customizar a saída:
--validate: Verifica o status dos links, indicando se eles estão funcionando ou quebrados.
--stats: Exibe estatísticas sobre os links, incluindo o total de links e a quantidade de links únicos.
--validate --stats: Combina as duas opções acima, exibindo estatísticas e verificando o status dos links.
Este projeto é licenciado sob a Licença ISC - consulte o arquivo LICENSE para obter mais detalhes.
Para maiores informações acesse: