Sintaxe Markdown: colinha completa

Atualizado em

Markdown é um jeito de formatar texto puro com símbolos simples — # para títulos, ** para negrito, - para listas — que o GitHub, editores e sites de documentação transformam em documento formatado. Esta página reúne todos os elementos com a sintaxe à esquerda e o resultado à direita: markdown básico, GitHub Flavored Markdown (GFM), alertas, emoji, links âncora e diagramas mermaid. Clique em Copiar em qualquer bloco.

Também disponível em: English · Русский · Tiếng Việt · Español

Sintaxe markdown resumida

ElementoSintaxeObservação
Título
# H1  ## H2  ### H3
Até seis #; coloque um espaço depois deles.
Negrito
**texto em negrito**
Itálico
*itálico* ou _itálico_
Negrito e itálico
***os dois***
Tachado
~~apagado~~
GitHub Flavored Markdown (GFM).
Código na linha
`código`
Bloco de código
```js
código
```
A palavra depois das crases define a linguagem do realce.
Link
[texto](https://example.com)
Imagem
![texto alternativo](imagem.png)
Lista com marcadores
- item
* e + também funcionam.
Lista numerada
1. item
Lista de tarefas
- [ ] a fazer
- [x] feito
GFM.
Citação
> texto citado
Tabela
| A | B |
| --- | --- |
| 1 | 2 |
GFM. Dois-pontos na segunda linha definem o alinhamento.
Linha horizontal
---
Quebra de linha
linha um\
linha dois
Uma barra invertida ou dois espaços no fim da linha.
Nota de rodapé
Texto[^1]

[^1]: A nota.
GFM.
Escapar um caractere
\*não é itálico\*
Uma barra invertida antes de qualquer símbolo do markdown.
Diagrama
```mermaid
flowchart LR
  A --> B
```
Renderiza no GitHub, no GitLab e no Docs MD.

Títulos

Seis níveis

# H1 — título da página
## H2 — seção
### H3 — subseção
#### H4
##### H5
###### H6

H1 — título da página

H2 — seção

H3 — subseção

H4

H5
H6

A convenção é um único H1 por documento. A sintaxe alternativa "sublinhada" (=== / ---) só cobre H1 e H2 — prefira a forma com #.

Ênfase

Negrito, itálico, os dois

**negrito** e *itálico* e ***negrito itálico***

negrito e itálico e negrito itálico

Sublinhados também funcionam (__negrito__, _itálico_), mas só os asteriscos funcionam no meio da palavra: fan**tás**tico.

Tachado (GFM)

~~riscado~~

riscado

Listas

Não ordenada

- Primeiro item
- Segundo item
  - Aninhado (recuo de 2 espaços)
- Terceiro item
  • Primeiro item
  • Segundo item
    • Aninhado (recuo de 2 espaços)
  • Terceiro item

Ordenada

1. Passo um
2. Passo dois
1. Os números que você digita não importam — o renderizador conta por você
  1. Passo um
  2. Passo dois
  3. Os números que você digita não importam — o renderizador conta por você

Lista de tarefas (GFM)

- [x] Lançar a funcionalidade
- [ ] Escrever a documentação
- [ ] Avisar alguém
  • Lançar a funcionalidade
  • Escrever a documentação
  • Avisar alguém

Código

Código na linha

Rode `npm install` antes de `npm run dev`.

Rode npm install antes de npm run dev.

Bloco cercado com linguagem

```ts
function greet(name: string) {
  return `Hello, ${name}`;
}
```
function greet(name: string) {
  return `Hello, ${name}`;
}

A tag de linguagem depois de ``` ativa o realce de sintaxe. Tags comuns: js, ts, python, bash, json, sql, diff.

Bloco dentro de bloco

````md
Para mostrar um bloco de código dentro de outro,
use mais crases no bloco de fora:
```js
console.log("nested");
```
````

Tabelas (GFM)

Tabela básica com alinhamento

| Esquerda | Centro | Direita |
| :--- | :----: | ----: |
| a    |   b    |     c |
| d    |   e    |     f |
EsquerdaCentroDireita
abc
def

Os dois-pontos na linha separadora controlam o alinhamento. Para uma barra vertical literal dentro da célula, escape com \|.

Citações

Citação e aninhamento

> Um parágrafo citado.
>
> > Citações aninhadas também funcionam.
>
> De volta ao primeiro nível — **a formatação funciona aqui dentro**.

Um parágrafo citado.

Citações aninhadas também funcionam.

De volta ao primeiro nível — a formatação funciona aqui dentro.

Comece cada linha com > (um > sozinho mantém juntos os parágrafos da mesma citação). O GitHub transforma citações > [!NOTE] / [!WARNING] em alertas coloridos.

Alertas (GitHub)

Uma citação cuja primeira linha é [!TIPO] vira uma caixa de destaque colorida no GitHub. São cinco tipos: NOTE, TIP, IMPORTANT, WARNING, CAUTION.

Os cinco tipos de alerta

> [!NOTE]
> Informação útil que o leitor deve saber.

> [!TIP]
> Uma dica para fazer algo melhor.

> [!IMPORTANT]
> Informação essencial para dar certo.

> [!WARNING]
> Informação urgente que pede atenção imediata.

> [!CAUTION]
> Consequências negativas de uma ação.

Nota Informação útil que o leitor deve saber.

Dica Uma dica para fazer algo melhor.

Importante Informação essencial para dar certo.

Aviso Informação urgente que pede atenção imediata.

Cuidado Consequências negativas de uma ação.

Aparecem como caixas coloridas com ícones no GitHub (READMEs, issues, PRs, discussions) e no GitLab. Em outros lugares — prévia do VS Code, Slack, Discord, Notion, a maioria dos geradores de sites estáticos — o texto literal "[!NOTE]" aparece dentro de uma citação simples, que é mais ou menos o que a prévia ao lado mostra.

Estrutura e espaçamento

Linha horizontal

Acima da linha.

---

Abaixo da linha.

Acima da linha.


Abaixo da linha.

Três ou mais hífens sozinhos na linha, com linhas em branco em volta (senão um --- logo abaixo de um texto vira H2).

Quebra de linha x novo parágrafo

Termine a linha com dois espaços  
para quebrar a linha no mesmo parágrafo.

Uma linha em branco começa um novo parágrafo.

Termine a linha com dois espaços
para quebrar a linha no mesmo parágrafo.

Uma linha em branco começa um novo parágrafo.

Uma barra invertida no fim da linha também força a quebra e é mais fácil de ver do que espaços no final.

Escapar caracteres

\*não é itálico\* e \# não é título e \| não é barra de tabela

*não é itálico* e # não é título e | não é barra de tabela

Notas de rodapé (GFM)

Referência e definição da nota

O Markdown foi criado em 2004.[^1]

[^1]: Por John Gruber, com contribuições de Aaron Swartz para a sintaxe.

O Markdown foi criado em 2004.1

Footnotes

  1. Por John Gruber, com contribuições de Aaron Swartz para a sintaxe. ↩

Funciona no GitHub e na maioria dos renderizadores modernos; não faz parte do markdown original.

Emoji

Códigos curtos e emoji literal

Pode lançar :tada: :rocket: — ou cole o caractere direto: 🎉 🚀

Códigos como :tada: não são markdown: GitHub, GitLab, Slack e Discord os convertem; renderizadores CommonMark, a prévia do VS Code e a maioria dos geradores de sites estáticos mostram os dois-pontos. Colar o emoji de verdade funciona em qualquer lugar.

Diagramas mermaid

Fluxograma em um bloco de código

```mermaid
graph LR
  A[Escrever markdown] --> B{Compartilhar?}
  B -->|sim| C[Gerar um link]
  B -->|não| D[Manter local]
```

Funciona no GitHub, no GitLab e nas páginas compartilhadas do Docs MD. Também faz diagramas de sequência, gráficos de Gantt e diagramas ER.

HTML na linha

Quando o markdown não dá conta

O markdown não tem sublinhado, então use <u>HTML</u>, <sub>subscrito</sub>, <sup>sobrescrito</sup> ou <kbd>Ctrl</kbd>+<kbd>C</kbd>.

O markdown não tem sublinhado, então use <u>HTML</u>, <sub>subscrito</sub>, <sup>sobrescrito</sup> ou <kbd>Ctrl</kbd>+<kbd>C</kbd>.

A maioria dos renderizadores deixa o HTML passar (o GitHub remove scripts e estilos). A prévia desta página remove HTML cru, então confira o resultado na plataforma de destino.

Teclas com <kbd>

Pressione <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> para abrir a paleta de comandos.

O GitHub mostra <kbd> como uma pequena tecla. Não existe sintaxe nativa do markdown para teclas; crases (`Ctrl`) são a alternativa em texto puro que funciona em qualquer lugar.

Seção recolhível com <details>

<details>
<summary>Clique para expandir</summary>

Conteúdo oculto — **o markdown funciona aqui** se você deixar uma linha em branco depois do summary.

</details>

Funciona no GitHub, no GitLab e na maioria dos sites de documentação. Use <details open> para começar aberto. Não funciona no Slack, no Discord nem no Notion.

Perguntas frequentes

O que é uma colinha de markdown?

É uma referência de uma página só com todos os elementos do markdown, mostrando a sintaxe e o resultado renderizado lado a lado, para você copiar os caracteres exatos em vez de adivinhar. Esta cobre o markdown básico, o GitHub Flavored Markdown (tabelas, listas de tarefas, tachado, notas de rodapé) e diagramas mermaid.

Como deixar o texto em negrito ou itálico no markdown?

Coloque o texto entre dois asteriscos para negrito (**negrito**) e entre um asterisco ou sublinhado para itálico (*itálico* ou _itálico_). Três asteriscos dão negrito itálico. No GitHub, sublinhados no meio de uma palavra não ativam a ênfase, então os asteriscos são a opção mais segura.

Como colocar um link ou uma imagem?

Um link é [texto](https://example.com) e uma imagem é igual, com um ponto de exclamação na frente: ![texto alternativo](imagem.png). Para mostrar um título ao passar o mouse, coloque um texto entre aspas depois da URL. Links por referência ([texto][id] mais [id]: url em uma linha própria) deixam documentos longos mais legíveis.

Como escrever um bloco de código?

Coloque o código entre duas linhas com três crases. Escreva o nome da linguagem logo depois das crases de abertura (```js) para ter realce de sintaxe. Use uma crase de cada lado para código no meio da linha.

Como fazer uma tabela no markdown?

Separe as colunas com barras verticais e coloque uma linha de hífens abaixo do cabeçalho. Dois-pontos nessa linha separadora definem o alinhamento: :--- à esquerda, :---: centralizado, ---: à direita. Tabelas são uma extensão do GFM suportada pelo GitHub, pelo GitLab e pela maioria dos renderizadores.

Qual a diferença entre Markdown e GitHub Flavored Markdown?

O GitHub Flavored Markdown (GFM) é o markdown original mais tabelas, listas de tarefas, tachado, links automáticos e notas de rodapé, com uma especificação formal baseada no CommonMark. Quase todo renderizador moderno suporta GFM, então é isso que as pessoas costumam chamar de "markdown". O próprio GitHub acrescenta alertas, códigos de emoji e mermaid em cima do GFM.

Qual markdown funciona no Slack, no Discord e no Notion?

Cada um é um dialeto diferente. O Discord suporta a maior parte do básico (**negrito**, *itálico*, blocos de código, títulos, citações), mas não tem tabelas nem imagens e usa __sublinhados__ para sublinhar. O Slack não é markdown: *um asterisco* é negrito, _sublinhado_ é itálico, ~til~ é tachado, e links [texto](url) só funcionam no campo de mensagem com a preferência de marcação ativada. O Notion converte markdown enquanto você digita e ao colar, inclusive tabelas e listas de tarefas. Confira a referência de cada plataforma antes de colar.

Como pular linha no markdown?

Uma única quebra de linha no texto não aparece no resultado. Termine a linha com dois espaços ou com uma barra invertida para quebrar a linha no mesmo parágrafo, ou deixe uma linha em branco para começar um novo parágrafo.

Como abrir um arquivo .md para ver a formatação?

Um arquivo .md é texto puro, então o Bloco de Notas ou o TextEdit mostram os símbolos crus. Para ver o documento formatado, abra-o em um visualizador markdown no navegador, como o do Docs MD, ou na pré-visualização do VS Code (Ctrl+Shift+V).