Cheat Sheet Markdown: Todos os 21 Elementos de Sintaxe em Uma Página
Um cheat sheet markdown é um guia rápido markdown em uma única página, que reúne cada elemento com sua sintaxe exata para você formatar um arquivo sem recorrer à documentação completa. Esta página cobre os 21 elementos em duas tabelas: os 10 elementos básicos que John Gruber definiu na especificação original de 2004 e os 11 elementos estendidos que variantes posteriores, como CommonMark (2014) e GitHub Flavored Markdown (2017), acrescentaram por cima. Todos os exemplos de sintaxe markdown desta página também funcionam no editor markdown online, onde a pré-visualização ao vivo mostra o resultado renderizado na tela enquanto você digita.
Sintaxe básica
A sintaxe básica cobre os 10 elementos do design original do markdown de 2004, e todo aplicativo markdown os renderiza de forma idêntica. Esses 10 elementos dão conta da maior parte da escrita do dia a dia: a estrutura vem de títulos e listas, a ênfase vem de negrito e itálico, e as referências vêm de links e imagens. Se um documento usa apenas as linhas desta tabela, ele renderiza corretamente no GitHub, no Obsidian, no Reddit, no Discord e em qualquer editor criado depois de 2004.
| Elemento | Syntax | Resultado renderizado |
|---|---|---|
| Título | # H1 / ## H2 / ### H3 | Títulos de seção nos níveis 1 a 6; um # por nível |
| Negrito | **strong words** | strong words |
| Itálico | *slanted words* | slanted words |
| Citação em bloco | > quoted line | Bloco de citação recuado com borda à esquerda |
| Lista ordenada | 1. Step one 2. Step two | Lista numerada; a numeração renderiza em sequência |
| Lista não ordenada | - First point - Second point | Lista com marcadores; * e + também funcionam como marcadores |
| Código | `inline code` | inline code em uma caixa monoespaçada |
| Linha horizontal | --- | Linha divisória de largura total entre seções |
| Link | [anchor text](https://example.com) | Hiperlink clicável com o rótulo "anchor text" |
| Imagem |  | Imagem incorporada com texto alternativo para acessibilidade |
O marcador de título precisa de um espaço depois do último #, e a linha horizontal precisa de uma linha em branco acima dela. Esses dois detalhes causam a maioria das falhas de renderização da sintaxe básica.
Sintaxe estendida
A sintaxe estendida acrescenta 11 elementos que a especificação original de 2004 nunca incluiu, e o suporte depende de qual variante de markdown cada aplicativo implementa. Tabelas, blocos de código cercados e listas de tarefas chegaram com o GitHub Flavored Markdown, que o GitHub formalizou como especificação em 2017. Notas de rodapé, listas de definição e destaque vêm de outras variantes e renderizam em menos aplicativos.
| Elemento | Syntax | Resultado renderizado |
|---|---|---|
| Tabela | | Name | Role | | --- | --- | | Ada | Engineer | | Grade com linha de cabeçalho e colunas alinhadas |
| Bloco de código cercado | ```json { "id": 1 } ``` | Caixa de código de várias linhas com realce de sintaxe opcional |
| Nota de rodapé | A claim.[^1] [^1]: The source. | Referência numerada com uma nota no fim da página |
| ID de título | ## Pricing {#pricing} | Título com âncora personalizada para links diretos |
| Lista de definição | Term : Meaning of the term | Termo em uma linha, definição recuada logo abaixo |
| Tachado | ~~old figure~~ | |
| Lista de tarefas | - [x] Ship the draft - [ ] Review edits | Checklist com caixas marcadas e desmarcadas |
| Atalho de emoji | :tada: | O caractere de emoji correspondente, 🎉 |
| Destaque | ==key phrase== | Frase sobre um fundo colorido |
| Subscrito | H~2~O | H₂O |
| Sobrescrito | x^2^ | x² |
O suporte varia por aplicativo: o GitHub renderiza tabelas, blocos de código cercados, listas de tarefas, tachado, notas de rodapé e atalhos de emoji, mas ignora destaque, subscrito e sobrescrito; o Obsidian lida com tabelas, notas de rodapé, listas de tarefas, tachado e destaque; o Discord aceita negrito, itálico, tachado e blocos de código, mas não tem suporte a tabelas nem a notas de rodapé. Quando a plataforma de destino é desconhecida, os 10 elementos básicos são o conjunto seguro.
Como usar este guia rápido
Localize o elemento na coluna da esquerda, copie a sintaxe da coluna do meio e substitua o texto de exemplo pelo seu próprio conteúdo. A coluna de resultado renderizado mostra como a saída aparece na tela, então você confirma que o elemento corresponde à sua intenção antes de copiar. Para qualquer item da tabela estendida, verifique primeiro a nota de suporte; uma nota de rodapé que renderiza no GitHub desaparece no Discord.
A forma mais rápida de verificar a sintaxe é colar o trecho no editor markdown online. A pré-visualização ao vivo renderiza cada elemento em milissegundos, então uma tabela quebrada ou um marcador ** sem fechamento aparece na tela imediatamente. Quem escreve em markdown todos os dias costuma memorizar a tabela básica em uma semana; a tabela estendida é a parte que vale a pena manter à mão.
Baixar e imprimir
Este cheat sheet markdown cabe em uma página A4 e está disponível como arquivo .md, então você pode guardar uma cópia no seu aplicativo de notas ou imprimir uma para deixar na mesa. O arquivo baixado é, ele próprio, markdown válido, e as duas tabelas renderizam corretamente em qualquer aplicativo com suporte a tabelas GFM. Abra o arquivo no editor, no Obsidian ou em um repositório do GitHub e a referência continua formatada.
Perguntas frequentes
Qual é a diferença entre sintaxe markdown básica e estendida?
Sintaxe básica são os 10 elementos da especificação original de 2004, e sintaxe estendida são os 11 elementos que variantes posteriores acrescentaram. Todo aplicativo markdown suporta o conjunto básico. O conjunto estendido depende da variante: o CommonMark padronizou o comportamento central em 2014, e o GFM adicionou tabelas, listas de tarefas e tachado em sua especificação de 2017.
Todos os aplicativos markdown suportam a sintaxe estendida?
Não. O suporte à sintaxe estendida difere de aplicativo para aplicativo, e nenhum app renderiza todos os 11 elementos estendidos. O GitHub pula destaque e subscrito, o Discord pula tabelas e notas de rodapé, e o Obsidian cobre a maior variedade entre os três. Documentos destinados a várias plataformas devem se apoiar na sintaxe básica mais as tabelas GFM.
Markdown é difícil de aprender?
Não. O markdown tem 21 elementos no total, e os 10 básicos cobrem a maioria dos documentos. Um # para títulos, ** para negrito e - para listas respondem pela maior parte do uso no mundo real. A maioria dos usuários passa a escrever markdown com fluência depois de uma única sessão em um editor com pré-visualização ao vivo, porque a pré-visualização corrige os erros na hora.