Pré-visualização de Markdown

O que faz a Pré-visualização de Markdown

A Pré-visualização de Markdown converte Markdown em HTML com o pacote marked enquanto escreve. Ajuda programadores e redatores a verificar excertos de README, entradas de changelog, secções de documentação, comentários de issues, blocos de código, listas e links antes da publicação. Ver o resultado ao lado do texto de origem torna os erros de formatação evidentes, sem abrir uma extensão de editor nem executar uma compilação da documentação.

Esta página foi pensada para o trabalho diário de quem desenvolve: verificações rápidas durante a depuração, preparação de pequenos exemplos para a documentação e limpeza de dados antes de os colar num editor, terminal, issue ou ficheiro de teste. A interface mantém a entrada, os controlos, a saída e a mensagem de estado lado a lado, para que o resultado seja fácil de confirmar antes de o copiar.

Fluxo de trabalho privado no navegador

Todo o processamento é feito com JavaScript no navegador. A ferramenta não envia o seu texto, tokens, URLs, excertos nem valores gerados para um servidor e não exige conta. Este modelo de privacidade é importante porque os pequenos utilitários recebem muitas vezes respostas reais de API, exemplos de configuração, registos, dados de autenticação ou exemplos semelhantes a dados de clientes durante a resolução de problemas. Trabalhar localmente reduz o risco e torna a ferramenta instantânea, pois não há comunicação de rede.

Dicas práticas

O botão de copiar copia o HTML gerado para inspeção ou prototipagem. A pré-visualização não adiciona nenhum sanitizador, por isso trate com cuidado o HTML produzido a partir de Markdown não fiável antes de o incorporar em páginas de produção. Para notas privadas e rascunhos internos, a principal vantagem é a rapidez: cole o texto, veja o resultado de imediato e mantenha o conteúdo no seu dispositivo.

Reveja sempre o resultado transformado antes de confiar nele em produção. Os utilitários do navegador são excelentes para inspeção e preparação, mas não conseguem conhecer todas as convenções de um projeto nem todos os requisitos de segurança. Se o resultado for ser enviado num commit, partilhado publicamente ou usado num fluxo de autenticação, confirme que não contém segredos e que corresponde ao formato esperado pela sua aplicação.