Prévia de Markdown

Todo o apelo do Markdown é que pode ser escrito e lido como texto simples, mas essa mesma simplicidade é exatamente o que torna certos erros invisíveis até serem renderizados — uma tabela à qual falta um caractere de barra vertical em sua linha separadora silenciosamente volta a aparecer como um parágrafo plano em vez de uma tabela, uma lista aninhada indentada com o número errado de espaços se anexa ao elemento pai errado, e não há nenhuma mensagem de erro para nenhum dos dois problemas, apenas uma saída que silenciosamente não parece como pretendido. Ver o resultado renderizado real atualizar continuamente enquanto você digita detecta exatamente esse tipo de erro de formatação no momento em que é introduzido, o que é consideravelmente mais rápido que escrever um README inteiro ou uma descrição de pull request às cegas e só descobrir que a formatação quebrou depois que já foi publicada em algum lugar.

GitHub, um site de documentação, e uma postagem de fórum podem renderizar a mesma fonte Markdown ligeiramente diferente em casos extremos mesmo todos amplamente suportando GFM, então pré-visualizar antes de publicar vale especialmente a pena quando o destino é um onde um erro de renderização seria visível para uma audiência ampla — um README público, um anúncio de lançamento, ou uma descrição de pull request que revisores realmente lerão com atenção.