Linter Markdown
Lint de problemas de estilo e estrutura Markdown
Markdown de entrada
Relatório de lint
Exemplos de lint Markdown
O linter sinaliza problemas de estilo: linhas longas, saltos de título, marcadores de lista mistos. Exemplo:
Markdown com problemas comuns
Linha longa, salto de título (H2 para H3 sem H1), marcadores de lista mistos - e *.
Cole no editor acima para ver o relatório de lint. Utilize Amostra para carregar mais.
O que é um linter Markdown?
Markdown é uma linguagem de marcação leve para documentação, READMEs e conteúdo web. Um linter verifica o seu Markdown quanto a problemas de estilo e estrutura: níveis de título inconsistentes, linhas em branco em falta, ligações quebradas ou formatação que pode não renderizar como esperado. A especificação CommonMark e GitHub Flavored Markdown (GFM) definem a sintaxe.
Esta ferramenta executa-se inteiramente no seu browser. O seu Markdown é analisado localmente—nada é enviado para um servidor. O relatório de lint lista problemas por linha com severidade (Erro, Aviso, Info). Para formatar Markdown: Formatador Markdown. Para validação: Validador Markdown.
Como utilizar esta ferramenta
Colar ou carregar
Cole o seu Markdown no editor da esquerda ou clique em Carregar para carregar um ficheiro .md, .markdown ou .txt. Utilize Amostra para carregar dados de exemplo com problemas comuns.
Rever o relatório de lint
O painel da direita mostra o relatório de lint com números de linha e descrições. Corrija os problemas no editor da esquerda; o relatório actualiza-se automaticamente. Utilize Copiar ou Transferir para guardar o relatório.
Corrigir e relint
Aborde cada problema e execute novamente. Para converter Markdown para HTML: Markdown para HTML. Para TOC a partir de títulos: Gerador TOC Markdown.
Quando o lint Markdown ajuda
Antes de fazer commit de documentação no GitHub ou publicar num CMS, o lint deteta problemas que poderiam quebrar a renderização ou confundir os leitores. Hierarquias de títulos inconsistentes tornam os TOCs pouco fiáveis. Ligações de referência quebradas causam 404s. Executar o seu Markdown aqui melhora a qualidade antes da revisão.
Sites de documentação, ficheiros README e artigos de blog beneficiam de Markdown consistente. Para converter para HTML: Markdown para HTML. Para gerar índice a partir de títulos: Gerador TOC Markdown. Para referência de sintaxe: Guia rápida Markdown.
Perguntas frequentes
Os meus dados são privados?
Sim. O lint executa-se inteiramente no seu browser. Nenhum dado é enviado para qualquer servidor. Pode confirmar abrindo o separador Rede do seu browser.
O que verifica?
As verificações típicas incluem consistência de títulos, linhas em branco à volta de blocos, formatação de listas, validade de ligações e conformidade CommonMark/GFM. As regras exactas dependem da implementação.
Linter vs Validador?
Um linter concentra-se em estilo e boas práticas. Um validador verifica correcção sintáctica. Utilize ambos para qualidade. Experimente Validador Markdown para validação.
Suporta GFM?
Muitos linters suportam GitHub Flavored Markdown (tabelas, listas de tarefas, riscado). Verifique o relatório para problemas específicos de GFM.
Pode corrigir problemas automaticamente?
Esta ferramenta reporta problemas; corrige-os manualmente. Para formatar (espaços, quebras de linha): Formatador Markdown.
Ferramentas relacionadas
Para sintaxe Markdown: CommonMark e especificação CommonMark. GitHub Flavored Markdown estende-a. Markdown Guide oferece tutoriais. Veja também GitHub, W3C HTML e Jekyll.