Pular para o conteúdo principal

Guia rápido & Referência de sintaxe Markdown

Copie exemplos funcionais da sintaxis que você precisa, veja como renderiza e use na sua documentação, arquivos README ou anotações.

Títulos

Adicione de 1 a 6 símbolos # no início da linha. Mais símbolos criam títulos de menor nível.

Sintaxe vs Visualização
Sintaxe copiável
# Heading Level 1
## Heading Level 2
### Heading Level 3
#### Heading Level 4
##### Heading Level 5
###### Heading Level 6
Visualização renderizada

Heading Level 1

Heading Level 2

Heading Level 3

Heading Level 4

Heading Level 5
Heading Level 6

Negrito, itálico e tachado

Envolva o texto com asteriscos, sublinhados ou tis para adicionar ênfase ou indicar texto excluído.

Sintaxe vs Visualização
Sintaxe copiável
This text is *italicized*.
This text is _italicized_ as well.

This text is **bolded**.
This text is __bolded__ as well.

This text is ***bold and italicized***.

This text is ~~strikethrough~~.
Visualização renderizada

This text is italicized.

This text is italicized as well.

This text is bolded.

This text is bolded as well.

This text is bold and italicized.

This text is strikethrough.

Listas ordenadas, com marcadores e de tarefas

Use números para etapas sequenciais, hífens para marcadores e colchetes com um x para tarefas.

Sintaxe vs Visualização
Sintaxe copiável
- Unordered list item 1
- Unordered list item 2
  - Indented nested item

1. Ordered list item 1
2. Ordered list item 2

- [x] Completed task item
- [ ] Incomplete task item
Visualização renderizada
  • Unordered list item 1
  • Unordered list item 2
    • Indented nested item
  1. Ordered list item 1
  2. Ordered list item 2
  • Completed task item
  • Incomplete task item

Código em linha e blocos de código

Use crases simples para código em linha e crases triplas com identificador de linguagem para blocos.

Sintaxe vs Visualização
Sintaxe copiável
Use inline `const value = true` variables.

Fenced code block:
```javascript
const greeting = "Hello, developer!";
console.log(greeting);
```
Visualização renderizada

Use inline const value = true variables.

javascript
const greeting = "Hello, developer!";
console.log(greeting);

Tabelas e alinhamento de colunas

Use barras verticais para separar colunas e hífens com dois-pontos na segunda linha para alinhar.

Sintaxe vs Visualização
Sintaxe copiável
| Parameter | Type | Default |
| :--- | :---: | ---: |
| format | string | "MD" |
| local | boolean | true |
| threads | number | 4 |
Visualização renderizada
Parameter Type Default
format string "MD"
local boolean true
threads number 4

Citações em bloco e aninhadas

Inicie as linhas com o símbolo de maior (>) para citar texto, avisos de destaque ou pensamentos aninhados.

Sintaxe vs Visualização
Sintaxe copiável
> This is a blockquote element.
>
> > This is nested inside the parent quote.
Visualização renderizada

This is a blockquote element.

This is nested inside the parent quote.

Linhas horizontais, notas de rodapé e HTML

Use três hífens para divisores, colchetes com circunflexo para notas ou tags HTML embutidas.

Sintaxe vs Visualização
Sintaxe copiável
Create dividers with asterisks:
***

Escape characters with backslash:
\* Literal asterisk (not bullet)

Embed keyboard labels:
<kbd>Cmd</kbd> + <kbd>Option</kbd>
Visualização renderizada

Create dividers with asterisks:


Escape characters with backslash:
* Literal asterisk (not bullet)

Embed keyboard labels:
Cmd + Option

Perguntas frequentes

O que é Markdown?

Markdown é uma linguagem de marcação leve que permite formatar texto simples usando símbolos simples e legíveis.

O GitHub-flavored Markdown (GFM) é suportado?

Sim. Esta referência e o editor suportam listas de tarefas, tabelas, tachado, links automáticos e blocos de código com destaque de sintaxe.

Como adicionar uma quebra de linha em Markdown?

Termine uma linha com dois espaços antes de pressionar Enter, ou deixe uma linha em branco para criar um novo parágrafo.

Posso escrever HTML dentro do Markdown?

Sim. A maioria dos renderizadores permite tags HTML padrão para elementos não suportados nativamente.