Skip to main content
CheckTown
Validadores

Validacao Markdown: verifique formatacao e estrutura

Publicado 5 min de leitura
Neste artigo

O que e a validacao Markdown?

A validacao Markdown verifica se o documento segue a sintaxe correta e sera renderizado corretamente em diferentes plataformas.

Documentacao e ficheiros README sao cada vez mais escritos em Markdown. A validacao garante renderizacao consistente.

Como funciona o validador Markdown

O validador Markdown do CheckTown analisa o conteudo e verifica erros de formatacao.

  • Verificacao de sintaxe — verifica niveis de cabecalho, formatacao de listas e sintaxe de links
  • Analise de estrutura — deteta problemas de hierarquia de cabecalhos
  • Verificacao de links — valida a sintaxe de links inline e de referencia

Experimente gratuitamente — sem cadastro

Valide o seu Markdown →

Erros Markdown comuns

Os erros Markdown sao subtis porque simplesmente renderizam incorretamente.

  • Linhas em branco em falta — Markdown requer linhas em branco antes de cabecalhos e listas
  • Marcadores de lista inconsistentes — misturar simbolos pode confundir parsers
  • Sintaxe de link partida — um parentese em falta transforma um link em texto

Quando usar a validacao Markdown

A validacao e mais valiosa quando documentos precisam funcionar em multiplas plataformas.

  • Documentacao — valide README antes do push
  • Conteudo de blog — verifique posts antes da publicacao
  • Padroes de equipa — aplique estilo via CI

Perguntas frequentes

Que especificacao usa?

Segue CommonMark, suportada pelo GitHub e GitLab.

Suporta GFM?

Sim. Extensoes GFM sao reconhecidas incluindo tabelas e blocos de codigo.

Deteta links partidos?

Verifica sintaxe de links mas nao se URLs sao acessiveis.

Ferramentas relacionadas