Referência

Folha de consulta Markdown

Todas as regras de Markdown que você precisa, com a sintaxe à esquerda e o resultado à direita. Abrange CommonMark e as extensões do GitHub Flavored Markdown.

Títulos

Seis níveis. Deixe uma linha em branco antes do título para que ele não seja absorvido pelo parágrafo acima.

Sintaxe

Resultado

Título de primeiro nível

# Heading level 1

Heading level 1

Título de seção

## Heading level 2

Heading level 2

Subseção

### Heading level 3

Heading level 3

Sintaxe alternativa para os níveis 1 e 2

Heading level 1
===============

Heading level 2
---------------

Heading level 1

Heading level 2

Ênfase

Asteriscos e sublinhados funcionam. Dentro de palavras, asteriscos são mais seguros.

Sintaxe

Resultado

Negrito

**bold text**

bold text

Itálico

*italic text*

italic text

Negrito e itálico

***bold and italic***

bold and italic

Tachado (GFM)

~~struck through~~

~~struck through~~

Listas

Recue dois espaços para aninhar. Listas numeradas se renumeram sozinhas, então você pode escrever 1. em todas.

Sintaxe

Resultado

Lista com marcadores

- First item
- Second item
- Third item

First item
Second item
Third item

Lista numerada

1. First item
1. Second item
1. Third item

First item
Second item
Third item

Lista aninhada

- Parent item
  - Child item
    - Grandchild item

Parent item
- Child item
  - Grandchild item

Lista de tarefas (GFM)

- [x] Finished task
- [ ] Open task

xFinished task
Open task

Links e imagens

Uma imagem é um link com um ponto de exclamação na frente. O texto alternativo conta para acessibilidade e SEO.

Sintaxe

Resultado

Link em linha

[Markdown to Image](https://markdowntoimage.com)

Markdown to Image

Link com título ao passar o mouse

[Markdown to Image](https://markdowntoimage.com "Convert Markdown")

Markdown to Image

Imagem

![A mountain at dusk](/photo.jpg)

A mountain at dusk

Link automático

<https://markdowntoimage.com>

https://markdowntoimage.com

Código

Escreva a linguagem após a cerca de abertura para obter realce de sintaxe.

Sintaxe

Resultado

Código em linha

Run `npm install` first.

Run npm install first.

Bloco de código

```
plain code block
```

plain code block

Bloco com realce

```js
const total = items.length;
```

const total = items.length;

Citações

Citações aceitam qualquer outro Markdown dentro, incluindo listas e código.

Sintaxe

Resultado

Citação

> Everything should be made as
> simple as possible.

Everything should be made as simple as possible.

Citação aninhada

> Outer quote
>
>> Inner quote

Outer quote
Inner quote

Tabelas

As colunas não precisam estar alinhadas no código-fonte. Os dois-pontos na linha divisória definem o alinhamento.

Sintaxe

Resultado

Tabela básica

| Format | Size |
| --- | --- |
| PNG | 240 KB |
| PDF | 96 KB |

Format	Size
PNG	240 KB
PDF	96 KB

Alinhamento de colunas

| Left | Center | Right |
| :--- | :----: | ----: |
| a | b | c |

Left	Center	Right
a	b	c

Outras sintaxes

Três ou mais hifens formam uma linha divisória. Termine a linha com dois espaços para forçar quebra sem abrir novo parágrafo.

Sintaxe

Resultado

Linha divisória

---

Quebra de linha forçada

First line ends here.\
Second line starts here.

First line ends here.
Second line starts here.

Escapar caractere especial

\*not italic\*

*not italic*

Nota de rodapé (GFM)

Text with a note.[^1]

[^1]: The note itself.

Text with a note.¹

Solução de Problemas

Suporte

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

GitHub Flavored Markdown (GFM) é um superconjunto do CommonMark. Ele acrescenta tabelas, listas de tarefas, tachado, notas de rodapé e link automático de URLs. Tudo marcado como GFM nesta página exige um renderizador compatível com essas extensões — a maioria dos modernos é.

Por que meu título não é renderizado?

A causa mais comum é a falta de espaço depois das cerquilhas. Escreva # Título, não #Título. A segunda causa é não deixar linha em branco acima, o que faz alguns analisadores tratarem o título como parte do parágrafo anterior.

Como faço quebra de linha sem começar novo parágrafo?

Termine a linha com dois espaços, ou use uma barra invertida no fim da linha. Uma quebra simples vira espaço na maioria dos analisadores, e uma linha em branco inicia um novo parágrafo.

Como mostro um asterisco ou sublinhado literal?

Coloque uma barra invertida na frente. Escrever \*texto\* renderiza como *texto* em vez de virar itálico. O mesmo vale para crases, cerquilhas, colchetes e outros caracteres do Markdown.

As tabelas de Markdown precisam de colunas alinhadas?

Não. As barras verticais não precisam ficar alinhadas no código — o renderizador cuida do layout. Alinhar apenas deixa o arquivo bruto mais legível. O que importa é a linha divisória sob o cabeçalho.