Início · Recursos · Teste de compatibilidade Markdown

Teste de compatibilidade Markdown: um pacote de teste .md prático

O Markdific Markdown Compatibility Test Pack é um arquivo .md reutilizável para verificar como editores, visualizadores, renderizadores e conversores de Markdown lidam com o mesmo documento. A pasta assets/ que o acompanha traz seis imagens locais de teste.
Um documento Markdown ligado a verificações de sintaxe, imagens, diagramas e compatibilidade de exportação
Todos os recursos

Obter o pacote de teste no GitHub

Selecione Code → Download ZIP para manter o documento e as imagens juntos. No repositório, você também pode inspecionar o código-fonte e revisar as alterações antes de baixar.

O pacote é distribuído sob a licença aberta CC BY 4.0. Você pode reutilizar ou adaptar o material de teste com atribuição. Isso não faz do app Markdific um software de código aberto.

Resposta rápida: baixe o ZIP, abra o mesmo arquivo .md em cada ferramenta, anote o que é renderizado corretamente e depois salve e exporte uma cópia de trabalho. Registre a renderização, os testes de ida e volta do Markdown e os formatos exportados como resultados separados.

O que o teste cobre

O documento da versão 1.0 tem 30 seções numeradas. Cada seção indica se testa CommonMark, GitHub Flavored Markdown (GFM), uma extensão comum, uma sintaxe específica de um app, o comportamento do HTML ou um teste de ida e volta.

Área Exemplos O que verificar
CommonMark Títulos, links, listas, citações, código, quebras de linha Análise e estrutura do documento
GFM Tabelas, listas de tarefas, tachado, links automáticos Suporte à sintaxe estendida
Imagens PNG, JPEG, WebP, nomes de arquivo com espaços, imagens remotas Carregamento e preservação de caminhos
Conteúdo técnico Fórmulas LaTeX e sete tipos de diagrama Mermaid Pré-visualização, exibição do código-fonte como alternativa, exportação
Sintaxe específica de apps Wikilinks, incorporações, callouts e tags do Obsidian Portabilidade e recuperação
Ida e volta Abrir, editar, salvar e exportar Reescritas do código-fonte e conteúdo perdido
Uma matriz de resultados que separa as verificações de renderização, salvamento e exportação de Markdown

Fórmulas, Mermaid e a sintaxe do Obsidian não fazem parte do CommonMark básico. Uma ferramenta pode renderizar CommonMark com precisão sem suportá-los. O pacote é um documento prático de comparação, não um conjunto formal de testes de conformidade com padrões.

Como fazer uma comparação justa

  1. Baixe o ZIP do repositório. Extraia sem separar o documento .md da pasta assets/.
  2. Mantenha uma cópia de referência intocada. Anote a versão do aplicativo, o sistema operacional, o modo do renderizador e a data do teste.
  3. Abra uma cópia de trabalho na primeira ferramenta. Confira o resultado renderizado e o código-fonte, quando disponível.
  4. Faça uma pequena edição, salve como Markdown e compare o arquivo salvo com a cópia de referência.
  5. Exporte para cada formato que a ferramenta oferece, como HTML, PDF ou DOCX. Abra cada exportação e inspecione-a separadamente.
  6. Repita com a mesma cópia de referência nas outras ferramentas. Preencha a tabela de resultados dentro do documento.
O fluxo do teste de compatibilidade Markdown, da cópia de referência intocada à renderização, ao salvamento, à exportação e à coleta de evidências

Não resuma todas as observações em uma única nota de “suporta Markdown”. Um visualizador pode renderizar um diagrama sem permitir editá-lo. Um conversor pode preservar a aparência no PDF e perder o código-fonte do Mermaid. São resultados diferentes.

Rótulos de resultado

  • Aprovado (Pass): a estrutura e o significado se mantêm após a operação testada.
  • Parcial (Partial): o conteúdo continua utilizável, mas a formatação, o código-fonte, os metadados ou a possibilidade de edição mudam.
  • Sem suporte (Unsupported): uma extensão de sintaxe opcional não está implementada, mas o código-fonte continua recuperável.
  • Reprovado (Fail): o conteúdo some, fica enganoso, executa conteúdo inseguro ou não pode ser recuperado.
  • Não testado (Not tested): a operação não pôde ser concluída ou não se aplica.

Registre a evidência por trás de cada rótulo. Por exemplo, “Mermaid exibido como bloco de código legível” costuma ser Sem suporte, e não Reprovado, a menos que a ferramenta anuncie suporte à renderização de Mermaid.

Testes de imagem: o que deve e o que não deve carregar

O ZIP contém seis imagens locais de teste que funcionam: PNG, JPEG, WebP, um nome de arquivo com espaços, uma imagem referenciada por HTML e uma imagem colada no estilo do Obsidian. Mantenha assets/ ao lado do documento. Os seis arquivos usam de propósito a mesma arte simples, para que a comparação isole o formato do arquivo e o tratamento de caminhos, sem diferenças visuais que não têm relação com o teste.

Dois outros caminhos ficam sem resolução de propósito quando o pacote é usado sozinho. Um caminho relativo à pasta pai depende de uma pasta maior, e um caminho relativo à raiz do site depende de um site. A imagem remota depende de acesso à rede. Esses casos testam como a ferramenta informa arquivos ausentes ou externos; não são arquivos faltando no ZIP.

Se todas as imagens locais incluídas falharem, verifique primeiro a extração, a localização das pastas e as permissões de arquivos locais antes de avaliar o renderizador.

O que inspecionar depois de salvar e exportar

A pré-visualização pode esconder mudanças no código-fonte. Confira no Markdown salvo se há destinos de links perdidos, caminhos de imagem reescritos, tabelas quebradas, delimitadores de código alterados, caracteres escapados ou metadados apagados. Uma normalização inofensiva da formatação é diferente de perda de significado.

No PDF, inspecione as quebras de página, a quebra de linhas no código, as fórmulas, a resolução dos diagramas e os links. No DOCX, verifique se títulos, tabelas, listas e imagens continuam editáveis. No HTML, verifique a estrutura, os arquivos locais e o tratamento seguro de HTML bruto.

O documento inclui um teste de script inofensivo. Uma pré-visualização segura pode escapar, remover ou exibir o código-fonte sem executá-lo. Não considere o bloqueio da execução do script uma falha.

Compartilhe resultados reproduzíveis

Ao publicar uma comparação, inclua a versão do pacote (1.0), a ferramenta e a versão dela, o sistema operacional, a configuração, o método de importação, as configurações de exportação, a tabela de resultados preenchida e capturas de tela das diferenças relevantes. Informe qualquer modificação feita no arquivo de teste.

O Markdific criou o pacote e pode ser um dos aplicativos testados. Aplique o mesmo arquivo e os mesmos critérios de avaliação a todos os aplicativos. Não trate a ausência de um recurso opcional como defeito só porque um dos produtos o implementa.

Baixar e reutilizar

Abrir o Markdown Compatibility Test Pack no GitHub

Use Code → Download ZIP para baixar juntos o documento .md, a pasta assets/, o README e a licença.

O documento e as imagens de teste incluídas são licenciados sob CC BY 4.0. Dê o crédito “Markdific Markdown Compatibility Test Pack v1.0”, inclua o link para o repositório e para a licença e indique as alterações se você adaptar o material.

Perguntas frequentes

Este é um conjunto de testes oficial do CommonMark?

Não. O CommonMark tem sua própria especificação e seus próprios exemplos de conformidade. Este pacote testa documentos e fluxos de trabalho práticos, incluindo extensões e exportação.

Posso testar um gerador de sites estáticos?

Sim. Anote o mecanismo, os plugins, a configuração, o tema, a versão do build e as regras de caminhos dos arquivos. Compare o HTML e os arquivos gerados, não apenas a pré-visualização de desenvolvimento.

Posso publicar ou modificar o pacote de teste?

Sim, sob a CC BY 4.0. Dê a atribuição, inclua o link para a licença e indique as alterações. Preserve o identificador da versão original nos resultados da comparação, para que os leitores saibam o que foi testado.

Referências