Markdown Preview
Understand Markdown Preview
Esta prévia renderiza Markdown em HTML enquanto você digita, para que você veja como um README ou um comentário longo vai ficar.
How it works
O Markdown é convertido por um conjunto de regras aplicadas em ordem: primeiro os blocos de código cercados, para que o conteúdo deles seja escapado e deixado em paz, e depois títulos, citações, linhas horizontais, listas, código inline, negrito, itálico e links. O HTML resultante é filtrado contra uma lista de permitidos — títulos, parágrafos, listas, code, pre, strong, em, blockquote, hr, br e links — e todo atributo é descartado, exceto um href http, https ou mailto, de modo que HTML bruto no código-fonte não pode ser executado.
When to use it
- Conferir os títulos e os blocos de código de um README antes de enviá-lo.
- Ver se o corpo longo de uma issue ou um comentário vai renderizar do jeito que você pretendia.
- Converter um trecho de Markdown em HTML que dá para colar em um CMS ou em um e-mail.
- Testar se uma lista ou um bloco de código aninhado está escrito corretamente.
Watch out for
- Isto é um subconjunto do CommonMark, não o GitHub Flavored Markdown. Tabelas, listas de tarefas, texto riscado, notas de rodapé e imagens não são renderizados — em vez disso, o texto-fonte aparece.
- Underscores dentro de uma palavra são lidos como ênfase, então snake_case_name renderiza com a palavra do meio em itálico. O CommonMark deliberadamente não faz isso; envolva identificadores em crases.
- O aninhamento é raso. Uma lista dentro de uma citação, ou uma sublista indentada, não vai sair como um parser completo produziria.
- HTML bruto no código-fonte é reduzido ao conteúdo de texto pelo sanitizador. Isso é intencional, e torna esta prévia mais rigorosa que o GitHub, que permite um conjunto limitado de tags.
Not the right tool for: Confirmar exatamente como o GitHub vai renderizar um arquivo. O GitHub sobrepõe as próprias extensões e o próprio sanitizador ao CommonMark; para uma conferência byte a byte, envie para um branch e olhe lá.
Frequently Asked Questions
Qual sintaxe de Markdown é suportada?
A especificação CommonMark: títulos com # (6 níveis), **negrito**, *itálico*, `código inline`, ```blocos de código cercados```, [links](url), , listas não ordenadas com -, listas ordenadas com 1., > citações, --- linhas horizontais e a sintaxe de | tabelas |.
Como pré-visualizar um README do GitHub?
Cole o conteúdo do seu README.md no editor. O GitHub usa um parser CommonMark rigoroso com extensões adicionais do GFM (GitHub Flavored Markdown) para listas de tarefas, tabelas e texto riscado. A prévia se aproxima bastante da renderização do GitHub.
Dá para exportar o HTML renderizado?
Sim — clique em "Copiar HTML" para obter a saída HTML renderizada. Isso é útil para colar conteúdo formatado em clientes de e-mail, em sistemas de CMS que aceitam HTML ou em templates de e-mail em HTML.
How to Use Markdown Preview
- Paste or type your input in the input area above.
- The tool processes your input automatically or click Run.
- Copy or download the result using the action buttons.
- Use Ctrl+Enter to run quickly from the keyboard.