Formatador de Markdown

Cole um documento Markdown e o formatador o reescreve em um estilo consistente: corrige saltos de nível de cabeçalho (sem H2 após H4), preenche colunas de tabela para alinhar na fonte, impõe uma única linha em branco entre blocos, normaliza marcadores de lista para -, colapsa sequências de linhas em branco e ordena definições de links de estilo de referência no final. O HTML renderizado não muda, apenas o arquivo fonte fica mais organizado, tornando as diferenças legíveis.

Como o formatador reescreve o Markdown

  1. 1

    Cole o Markdown

    Cole o documento bruto, README, página de docs, notas de reunião.

  2. 2

    Escolha opções de estilo

    Marcador de lista (`-`/`*`), estilo de cabeçalho (ATX/Setext), alinhamento de tabela, coluna de quebra.

  3. 3

    Formatar

    A ferramenta analisa o documento em um AST e o re-serializa com o estilo escolhido.

  4. 4

    Diferença na saída

    Uma visualização lado a lado mostra o que mudou antes de você colar de volta.

O que o formatador corrige

  • Marcadores de lista. *, -, + são normalizados para um único caractere consistente (padrão -).
  • Hierarquia de cabeçalhos. Avisos (ou promove) quando H2 é seguido por H4 sem H3 entre eles.
  • Linhas em branco. Exatamente uma linha em branco entre blocos; sem sequências de três ou mais.
  • Tabelas. Preenche cada coluna para que os pipes se alinhem na fonte, mesmo que os renderizadores de Markdown não se importem.
  • Espaços em branco finais. Remove espaços finais em cada linha, exceto o marcador de quebra de linha intencional de dois espaços.
  • Links de referência. Coleta definições de [label]: url no final do documento, ordenadas alfabeticamente.
  • Blocos de código. A tag de linguagem é normalizada para minúsculas; blocos de código baseados em indentação se tornam blocos cercados.

Opções de estilo que você pode definir

Opção Padrão Alternativas
Marcador de lista - *, +
Estilo de cabeçalho ATX Setext para H1/H2
Delimitador de ênfase * _
Delimitador de negrito ** __
Coluna de quebra 0 (desligado) 80, 100, 120
Ordenar links de referência ligado desligado

Por que o Markdown consistente é importante

Em um repositório de equipe, Markdown inconsistente produz diffs barulhentos: toda vez que alguém salva um arquivo com um editor diferente, os marcadores de lista trocam e as tabelas se reorganizam. Um formatador impõe um estilo para que os revisores de pull request vejam apenas mudanças de conteúdo. Pense nisso como prettier para prosa.

Quando não formatar

  • Blocos de código cercados permanecem intactos, o formatador nunca tocará o conteúdo de um bloco de código. Se a formatação mudar o código, é um bug.
  • Quebras de linha intencionais em larguras estreitas (readme.md em um projeto de terminal) serão reformatadas se você ativar a coluna de quebra. Desative a quebra se você mantiver quebras de linha ajustadas manualmente.
  • Blocos HTML incorporados passam sem mudanças.

Substituições diretas

Se você preferir um CLI local, o formatador usa as mesmas regras de AST que remark-stringify com o plugin remark-gfm. prettier --parser markdown produz um resultado semelhante.

Perguntas frequentes

Não. O formatador reescreve apenas a fonte, a saída HTML renderizada antes e depois deve ser equivalente. Se você notar uma mudança na renderização, reporte como um bug.

Não. O front-matter YAML ou TOML no topo do arquivo é detectado e passado sem alterações.

Sim, defina a coluna de quebra para 80, 100 ou 120 e os parágrafos serão reformatados. Linhas dentro de blocos de código nunca são tocadas.

Não. O formatador assume que seus links funcionam; ele apenas reorganiza definições de links de referência. Use uma ferramenta de verificação de links separadamente.

Não. A análise e formatação ocorrem no seu navegador; o conteúdo nunca sai do seu dispositivo.

Ferramentas relacionadas

Ferramenta disponível em outros idiomas