Você escreve um README com marcadores aninhados, alguns blocos de código e uma tabela comparando duas abordagens. Parece bom como texto simples no seu editor. Depois você envia para o GitHub e a tabela está desalinhada, um dos seus blocos de código não fechou corretamente, e uma lista numerada reiniciou em 1 no meio por causa de uma linha em branco perdida. Agora você está enviando pequenos commits de correção só para acertar a formatação.
O Markdown é simples o suficiente para escrever de memória para formatação básica, mas tabelas, listas aninhadas e blocos de código têm pequenas peculiaridades de sintaxe que diferem ligeiramente entre renderizadores. O GitHub Flavored Markdown não é idêntico ao CommonMark, que não é idêntico ao que quer que seu gerador de site estático use. A diferença entre "parece certo na minha cabeça" e "renderiza certo na página" é exatamente onde uma pré-visualização em tempo real se mostra valiosa.
Por Que Fazer Commit para Verificar É um Fluxo de Trabalho Ruim
Enviar um commit apenas para ver como um README renderiza, depois enviar outro para corrigir uma tabela quebrada, e mais um para corrigir a correção, enche seu histórico de commits com ruído de formatação que não tem nada a ver com o conteúdo real. Também significa que cada ciclo de pré-visualização leva tanto tempo quanto um push e um recarregamento de página — lento o suficiente para você desistir de verificar e simplesmente esperar que fique bom.
Veja o Resultado Renderizado Enquanto Digita
Bellows inclui uma ferramenta de pré-visualização de Markdown que renderiza a saída formatada enquanto você cola ou digita Markdown bruto. Cabeçalhos, listas, tabelas, links e blocos de código são todos renderizados imediatamente, para que você possa detectar erros de formatação antes que acabem em um commit.
Escrevendo READMEs e Descrições de PR
Descrições de pull request e arquivos README costumam ser a primeira coisa que um revisor ou novo colaborador lê. Verificar se cabeçalhos, listas de verificação e imagens vinculadas renderizam corretamente antes de enviar economiza uma rodada de comentários do tipo "você pode corrigir a formatação".
Redigindo Documentação Offline
Escrever documentação em um voo ou em uma área com internet instável não significa desistir de ver sua formatação renderizada corretamente. Uma ferramenta de pré-visualização local funciona da mesma forma, esteja você conectado ou não.