Guia rápido de Markdown — sintaxe com prévia ao vivo

De um a seis # seguidos de um espaço. Use um título # por documento e não pule níveis; leitores de tela e sumários dependem da ordem.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

O estilo mais antigo, "setext"; só níveis 1 e 2. Uma linha de --- abaixo de um parágrafo o transforma em título, o que surpreende quem esperava uma linha horizontal: deixe uma linha em branco antes do ---.

Heading 1
=========

Heading 2
---------

Uma linha em branco separa parágrafos. Uma única quebra de linha dentro de um parágrafo é juntada em uma linha só (exceto nos casos citados em quebras de linha).

First paragraph, which can wrap
across several source lines.

Second paragraph after a blank line.

Para quebrar a linha sem criar um novo parágrafo, termine a linha com dois espaços ou uma barra invertida. Comentários do GitHub, o Obsidian (por padrão), o Slack e o Discord tratam cada nova linha como quebra.

Two trailing spaces  
make a break.
A trailing backslash\
works too.<br>So does an HTML br.

Asteriscos funcionam dentro de palavras; sublinhados não (nomes_em_snake_case continuam literais), e por isso a maioria dos guias de estilo prefere *.

**bold** or __bold__

*italic* or _italic_

***bold italic***

in**side**word works with *, not with _

Comece cada linha com >. Citações podem conter qualquer outro Markdown, incluindo listas e código.

> Quoted text.
> Still quoted.
>
> > Nested quote.

-, * ou + funcionam; não misture na mesma lista (um marcador diferente inicia uma nova lista).

- Item
- Item
  - Nested (indent 2 spaces)
- Item

O primeiro número define o início; os seguintes são ignorados, então usar "1." em todas as linhas renumera sozinho quando você reordena os itens.

1. First
1. Second
1. Third

3. Starts at three
4. Four

Recue o conteúdo extra para alinhar com o primeiro caractere do texto do item (3 espaços depois de "1. ").

1. Install:

   ```sh
   npm install marked
   ```

2. Indent continuation lines
   to the item text.

Markdown entre crases não é interpretado.

Run `npm test` now.

Use ``double `backticks` `` when the code contains one.

Três crases (ou ~~~) em linhas próprias. A palavra depois da cerca indica a linguagem para o destaque de sintaxe no GitHub, GitLab, Obsidian e Discord.

```js
const answer = 42;
console.log(answer);
```

const answer = 42;
console.log(answer);

A sintaxe original. As cercas são mais claras e permitem indicar a linguagem; código com recuo é a única forma que o Reddit antigo entende.

Paragraph.

    four spaces of indent
    make a code block

four spaces of indent
make a code block

Três ou mais -, * ou _ em uma linha própria, com uma linha em branco acima.

Above

---

Below (also *** or ___)

A forma com sinais de menor e maior é o autolink do CommonMark. Espaços em um URL devem ser escritos como %20, ou o URL deve ficar entre <…>.

[Link text](https://freetoolsforweb.com)

[With a title](https://freetoolsforweb.com "Hover text")

[Relative link](/tools/regex-cheat-sheet)

<https://example.com>

Tira URLs longos do texto. As definições podem ficar em qualquer lugar do documento e não são exibidas.

Read the [spec][cm] and the [GFM spec].

[cm]: https://spec.commonmark.org/
[GFM spec]: https://github.github.com/gfm/

No GitHub e no GitLab, cada título ganha um id automático: em minúsculas, espaços viram hifens, pontuação é removida ("## Install & Run" vira #install--run). O Obsidian usa [[#Título]].

[Jump to tables](#md-tables)

Como um link com ! na frente. O texto entre [ ] é o texto alternativo: descreva a imagem para quem não pode vê-la. O Markdown não tem sintaxe de tamanho; use HTML <img width="200"> onde HTML for permitido.

![Site logo](/brand/favicon.svg "Optional title")

[![Clickable image](/brand/favicon.svg)](/tools)

Uma barra invertida torna literal qualquer pontuação ASCII: \ ` * _ { } [ ] ( ) # + - . ! |

\*not italic\*  \# not a heading  1\. not a list

Permitido pelo CommonMark. GitHub e GitLab mantêm um subconjunto seguro (sem script, style ou manipuladores de eventos); Slack, Discord, Reddit e Notion mostram como texto.

Press <kbd>Ctrl</kbd> + <kbd>C</kbd>, H<sub>2</sub>O, x<sup>2</sup>.

Um comentário HTML fica no código-fonte, mas não é exibido onde HTML é permitido.

Visible.

<!-- Not rendered: notes for editors -->

Also visible.

A segunda linha é obrigatória; os dois-pontos definem o alinhamento. As colunas não precisam estar alinhadas no código-fonte. Para uma barra vertical literal, use \|. Sem células mescladas nem células com várias linhas (use <br> dentro de uma célula no GitHub).

Onde: GFM, GitLab, Obsidian, Reddit; Notion ao colar

| Left | Centre | Right |
| :--- | :----: | ----: |
| a    |   b    |     1 |
| `c`  | **d**  |    22 |

No GitHub e no GitLab, as caixas são clicáveis em issues e pull requests e atualizam o código-fonte.

Onde: GFM, GitLab, Obsidian; Notion com o atalho []

- [x] Write the draft
- [ ] Review
- [ ] Publish

Dois tils em todo lugar; o GitHub também aceita um. O Slack usa ~um~ til, o Jira -hifens-.

Onde: GFM, GitLab, Obsidian, Discord, Reddit, Notion

~~no longer true~~

O GFM transforma URLs soltos e endereços www. em links. No CommonMark puro, eles continuam como texto, a menos que estejam entre <…>.

Onde: GFM, GitLab, Obsidian, Slack, Discord, Reddit

Visit https://freetoolsforweb.com or www.example.com.

A definição pode ficar em qualquer lugar; as notas são numeradas na ordem de referência e listadas no final. O Obsidian também tem notas inline: ^[assim].

Onde: GFM, GitLab, Obsidian (não CommonMark)

Markdown was created in 2004.[^1]

[^1]: By John Gruber, with Aaron Swartz.

Você mesmo define a âncora. Suportado por Pandoc, PHP Markdown Extra, Hugo, Jekyll (kramdown), MkDocs e Docusaurus; GitHub e GitLab ignoram e mostram as chaves, usando ids automáticos.

Onde: Pandoc, Hugo, Jekyll, MkDocs, Docusaurus; não GitHub nem GitLab

### Install {#setup}

Nomes entre dois-pontos. Digitar dois-pontos no GitHub, Slack, Discord ou Notion abre um seletor de emojis. Colar o próprio emoji funciona em todo lugar.

Onde: GitHub, GitLab, Slack, Discord; não Obsidian (sem plugin) nem CommonMark

Ship it :rocket: :+1: :tada:

TeX entre sinais de $ inline, $$ para um bloco de destaque. O GitHub também aceita $`…`$ e um bloco ```math; o GitLab suporta as mesmas formas. O Notion usa $$…$$ para equações inline.

Onde: GitHub, GitLab, Obsidian, Notion (sintaxe própria)

Inline: $E = mc^2$

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Um bloco de código com a linguagem mermaid vira um diagrama: fluxogramas e diagramas de sequência, de classes, de estados, de Gantt e ER.

Onde: GitHub, GitLab, Obsidian, Notion (bloco de código Mermaid)

```mermaid
flowchart LR
  A[Write] --> B{Review}
  B -->|ok| C[Publish]
  B -->|changes| A
```

O GitHub tem cinco tipos: NOTE, TIP, IMPORTANT, WARNING, CAUTION. O GitLab (17.10+) aceita a mesma sintaxe. O Obsidian tem muito mais tipos, títulos personalizados (> [!tip] Título) e recolhimento (> [!faq]-).

Onde: GitHub, GitLab 17.10+, Obsidian; uma citação comum nos demais

> [!NOTE]
> Useful information.

> [!WARNING]
> Critical content that needs attention.

É HTML, mas amplamente suportado. Deixe linhas em branco em volta do Markdown interno, senão ele não é interpretado.

Onde: GitHub, GitLab, Obsidian, a maioria dos geradores de sites estáticos

<details>
<summary>Click to expand</summary>

Hidden **Markdown** content.

</details>

Obsidian e alguns editores (Typora, iA Writer); o GitHub mostra os sinais de igual. Use <mark> onde HTML for permitido.

Onde: Obsidian, Typora; não GitHub

This is ==highlighted== text.