Lição 6

Fluxo de escrita em Markdown

Revise estrutura de títulos, links, tabelas e erros comuns de Markdown antes de publicar.

Antes de publicar Markdown no GitHub, em um repositório de docs ou em um campo de CMS, faça uma revisão curta.

Fluxo prático

  1. Rascunhe o documento em Markdown.
  2. Pré-visualize a saída renderizada.
  3. Verifique o outline de títulos por níveis pulados ou seções faltando.
  4. Revise a lista de links por URLs quebradas ou placeholder.
  5. Confirme que tabelas, blocos de código e task lists renderizam corretamente.
  6. Copie Markdown para destinos baseados em Git, ou HTML para caminhos CMS/e-mail.

Erros comuns de Markdown

  • Níveis de título pulados: ir de # para ### sem ##
  • Listas quebradas: falta linha em branco antes de listas em alguns renderers
  • Blocos de código não fechados: esquecer as crases finais
  • Ruído de alinhamento em tabela: linhas com contagem de colunas inconsistente
  • Links placeholder: deixar https://example.com na doc final
  • HTML em excesso: depender de HTML bruto quando sintaxe Markdown seria mais clara

Checagens de estrutura importam mais que estilo

Qualidade de Markdown é sobretudo:

  • títulos fáceis de escanear
  • parágrafos curtos
  • links explícitos
  • amostras de código que funcionam
  • tabelas que combinam com o formato dos dados

Cores do tema de prévia não viajam com o documento. A estrutura viaja.

Conclusão

Trate revisão de Markdown como um passo leve de QA de docs: pré-visualizar, inspecionar estrutura, validar links e escolher o formato de exportação certo para o destino.

A ferramenta Visualizar Markdown / Markdown para HTML suporta este fluxo com prévia ao vivo, outline de títulos, lista de links e ações de copiar em um só workspace.

Voltar à visão geral do curso