Fatos principais
- Categoria
- Desenvolvimento e Web
- Tipos de entrada
- textarea, select
- Tipo de saída
- text
- Cobertura de amostras
- 4
- API disponível
- Yes
Visão geral
O Verificador de Links Markdown é uma ferramenta estática projetada para analisar seus documentos Markdown e identificar instantaneamente erros de formatação, âncoras internas quebradas e referências não definidas, tudo isso de forma local e sem realizar requisições de rede.
Quando usar
- •Antes de publicar artigos ou documentações técnicas em repositórios Git para garantir que todos os links internos funcionem.
- •Ao revisar arquivos Markdown extensos com múltiplos cabeçalhos e links de âncora complexos.
- •Para validar a estrutura de referências e links de rodapé em relatórios ou e-books escritos em Markdown.
Como funciona
- •Insira o texto Markdown que você deseja validar no campo de entrada principal.
- •Selecione o nível de verificação desejado: Básico para formatos e âncoras, ou Estrito para incluir referências duplicadas ou não utilizadas.
- •Escolha o formato de saída do relatório entre Texto simples ou JSON.
- •Analise o relatório gerado para identificar a linha exata e o tipo de inconsistência encontrada nos links.
Casos de uso
Exemplos
1. Validação de Documentação Técnica
Redator Técnico- Contexto
- Um redator técnico está finalizando a documentação de uma API em Markdown e precisa garantir que todos os links internos para seções específicas estejam corretos.
- Problema
- O documento possui mais de 50 cabeçalhos e vários links de âncora que podem estar apontando para IDs incorretos ou inexistentes.
- Como usar
- Cole o conteúdo do arquivo Markdown no campo de entrada, selecione o nível de verificação 'Básico' e escolha o formato de relatório 'Texto'.
- Configuração de exemplo
-
checkLevel: basic, reportFormat: text - Resultado
- A ferramenta identifica rapidamente que o link '[Configuração](#configuracao)' está quebrado porque o cabeçalho real está escrito como '## Configurações'.
2. Limpeza de Referências Não Utilizadas
Desenvolvedor de Software- Contexto
- Um desenvolvedor mantém um arquivo README extenso com dezenas de links de referência no final do arquivo acumulados ao longo do tempo.
- Problema
- Identificar quais referências de links no rodapé não estão mais sendo citadas no corpo do texto para limpar o arquivo.
- Como usar
- Insira o texto do README, configure o nível de verificação para 'Estrito' e selecione o formato 'JSON' para processar os dados.
- Configuração de exemplo
-
checkLevel: strict, reportFormat: json - Resultado
- O relatório JSON gerado lista todas as referências declaradas no final do documento que não possuem nenhuma associação no corpo do texto, facilitando a remoção.
Testar com amostras
markdownHubs relacionados
FAQ
Esta ferramenta faz requisições de rede para testar links externos?
Não. A verificação é puramente estática, analisando apenas a sintaxe, âncoras internas e referências locais no próprio texto.
Qual é a diferença entre o nível de verificação Básico e o Estrito?
O nível Básico valida formatos e âncoras quebradas. O Estrito adiciona a detecção de referências não utilizadas e âncoras duplicadas.
Como a ferramenta valida âncoras internas?
Ela mapeia os cabeçalhos do documento e verifica se os links de âncora correspondem a algum cabeçalho existente.
Posso exportar o relatório de erros?
Sim, você pode gerar o relatório no formato de Texto estruturado ou em JSON para integração com outros fluxos.
A ferramenta suporta links de referência no rodapé?
Sim, ela valida se todas as referências declaradas no rodapé estão corretamente associadas e se há referências indefinidas.