Folha de Consulta Markdown
Última atualização
Títulos
Coloque um espaço depois dos sinais #. A quantidade de sinais define o nível, de 1 a 6.
| Elemento | Markdown | Resultado |
|---|---|---|
| Título 1 | # Page title | Título de nível mais alto, <h1> |
| Título 2 | ## Section | Título de seção, <h2> |
| Título 3 | ### Subsection | Título de subseção, <h3> |
| Títulos 4 a 6 | #### Level 4
##### Level 5
###### Level 6 | <h4>, <h5> e <h6> |
| Título 1, forma alternativa | Page title
========== | <h1>, o mesmo que # Page title |
| Título 2, forma alternativa | Section
------- | <h2>, o mesmo que ## Section |
| Cerquilhas de fechamento | ## Section ## | <h2>Section</h2>; os sinais # do final são descartados |
| Espaço faltando | #Not a heading | Um parágrafo comum. O espaço depois de # é obrigatório |
Negrito, itálico e riscado
Asteriscos funcionam em qualquer lugar, até no meio de uma palavra. Underscores só funcionam nos limites de palavra, então snake_case fica como foi digitado.
| Elemento | Markdown | Resultado |
|---|---|---|
| Negrito | **bold text** | Negrito, <strong>bold text</strong> |
| Negrito com underscores | __bold text__ | Negrito, igual ao de cima |
| Itálico | *italic text* | Itálico, <em>italic text</em> |
| Itálico com underscores | _italic text_ | Itálico, igual ao de cima |
| Negrito e itálico | ***bold and italic*** | <em><strong>bold and italic</strong></em> |
| Negrito no meio da palavra | un**believ**able | Só o meio da palavra fica em negrito |
| Underscores numa palavra | snake_case_name | Texto comum, sem itálico |
| Riscado (GFM) | ~~no longer true~~ | Texto riscado, <del>no longer true</del> |
| Sublinhado | <ins>underlined</ins> | Texto sublinhado. Markdown não tem sintaxe de sublinhado, então isto é HTML |
| Destaque | <mark>highlighted</mark> | Texto destacado nos sites que permitem a tag <mark>. Markdown não tem sintaxe de destaque |
Quebras de linha e parágrafos
Apertar Enter uma vez dentro de um parágrafo não começa uma nova linha no resultado. Use uma destas opções.
| Elemento | Markdown | Resultado |
|---|---|---|
| Novo parágrafo | First paragraph.
Second paragraph. | Dois parágrafos. Uma linha em branco os separa |
| Quebra: dois espaços | Roses are red,
Violets are blue. | Um parágrafo com um <br> depois de red,. A primeira linha termina com dois espaços, que você não vê |
| Quebra: barra invertida | Roses are red,\
Violets are blue. | O mesmo <br>, com uma marca visível. Funciona no CommonMark e no GitHub |
| Quebra: HTML | Roses are red,<br>Violets are blue. | O mesmo <br>. Também funciona dentro de uma célula de tabela |
| Uma única quebra de linha | Roses are red,
Violets are blue. | Uma linha só: Roses are red, Violets are blue. Issues e comentários do GitHub mantêm a quebra; arquivos .md não |
| Linhas em branco extras | One.
Two. | O mesmo que uma linha em branco. Para mais espaço, coloque <br> numa linha própria |
Listas
Recue um item aninhado para ele ficar alinhado com o texto do item de cima: 2 espaços debaixo de - , 3 espaços debaixo de 1. .
| Elemento | Markdown | Resultado |
|---|---|---|
| Lista com marcadores | - Apples
- Pears
- Plums | Uma lista com marcadores, <ul> com três <li> |
| Outros marcadores | * Apples
+ Pears | * e + também criam marcadores. Trocar o caractere começa uma nova lista |
| Lista numerada | 1. Install
2. Configure
3. Run | Uma lista numerada, <ol> |
| Numeração preguiçosa | 1. Install
1. Configure
1. Run | Continua numerada 1, 2, 3. Só o primeiro número conta |
| Começar num número | 7. Seventh
8. Eighth | <ol start="7">, numerada a partir de 7 |
| Lista aninhada | - Fruit
- Apple
- Pear
- Vegetables | Uma lista dentro do primeiro item |
| Aninhada, numerada | 1. Download
- Windows
- macOS
2. Install | Marcadores dentro do passo 1, recuados 3 espaços |
| Parágrafo num item | - First item
More about the first item.
- Second item | Dois parágrafos dentro do primeiro item |
| Código num item | 1. Run this:
```bash
npm install
```
2. Start the app | Um bloco de código dentro do passo 1, recuado até o texto do item |
Listas de tarefas (checkboxes)
Uma extensão do GitHub Flavored Markdown: um item de lista que começa com [ ] ou [x] vira uma checkbox.
| Elemento | Markdown | Resultado |
|---|---|---|
| Checkbox vazia | - [ ] Write tests | Uma checkbox desmarcada |
| Checkbox marcada | - [x] Write tests | Uma checkbox marcada. [X] também funciona |
| Checklist | - [x] Draft
- [ ] Review
- [ ] Publish | Uma caixa marcada e duas vazias. Em issues e pull requests do GitHub dá para marcá-las com um clique |
| Tarefas aninhadas | - [ ] Release
- [x] Tag the commit
- [ ] Write the notes | Duas subtarefas debaixo da primeira caixa |
| Espaço faltando | - [] Write tests | Um marcador comum que mostra [] Write tests. Os colchetes precisam de um espaço ou de um x |
Links
O texto do link vai entre colchetes e o endereço entre parênteses logo depois, sem espaço entre eles.
| Elemento | Markdown | Resultado |
|---|---|---|
| Link inline | [Coddy](https://coddy.tech) | <a href="https://coddy.tech">Coddy</a> |
| Link com título | [Coddy](https://coddy.tech "Learn to code") | O mesmo link. O título aparece como tooltip ao passar o mouse |
| URL entre sinais de menor e maior | <https://coddy.tech> | A própria URL, como link |
| URL solta (GFM) | https://coddy.tech | Um link no GitHub e em outros sites GFM, que também transformam endereços www. em link. Texto comum no CommonMark estrito |
| Link de e-mail | <hello@example.com> | Um link mailto: |
| Link por referência | Read the [docs][1].
[1]: https://example.com/docs | docs aponta para a URL. A linha [1]: não aparece |
| Referência abreviada | See [GitHub].
[GitHub]: https://github.com | GitHub aponta para a URL |
| Link relativo | [Install guide](docs/install.md) | Um link para um arquivo relativo a este. No GitHub ele abre o arquivo no repositório |
| Link para um título | [Jump to setup](#getting-started) | Rola até ## Getting Started na mesma página |
| IDs dos títulos | ## Getting Started! | Recebe o ID getting-started no GitHub: minúsculas, espaços viram hífens, e a pontuação que não seja - e _ é removida |
| Título em outro arquivo | [Requirements](docs/install.md#requirements) | Abre o arquivo naquele título |
| Espaços na URL | [Report](my%20report.pdf) | Escreva cada espaço como %20, ou envolva a URL em sinais de menor e maior: [Report](<my report.pdf>) |
| Abrir em nova aba | <a href="https://coddy.tech" target="_blank">Coddy</a> | Markdown não tem sintaxe para isso. O HTML funciona nos sites que mantêm o atributo target |
Imagens
Uma imagem é um link com ! na frente. O texto entre colchetes vira o texto alternativo, que os leitores de tela leem em voz alta.
| Elemento | Markdown | Resultado |
|---|---|---|
| Imagem |  | <img src="cat.png" alt="A cat asleep on a sofa"> |
| Imagem com título |  | A mesma imagem com um tooltip ao passar o mouse |
| Imagem de uma URL |  | Carrega a imagem da web |
| Imagem com link | [](https://coddy.tech) | Uma imagem que abre o link quando clicada |
| Imagem por referência | ![Logo][logo]
[logo]: images/logo.png | O mesmo que uma imagem inline, com a URL definida uma vez abaixo |
| Tamanho da imagem | <img src="logo.png" alt="Logo" width="200"> | A imagem, com 200 pixels de largura. Markdown puro não tem sintaxe de tamanho, então isto é uma tag HTML <img> |
| Imagem centralizada | <p align="center">
<img src="logo.png" alt="Logo" width="200">
</p> | Uma imagem centralizada, como se vê em muitos README do GitHub |
Código e blocos de código
Crases marcam código dentro de uma linha; uma cerca de três crases marca um bloco. Nada dentro do código é formatado.
| Elemento | Markdown | Resultado |
|---|---|---|
| Código inline | Run `npm install` first. | npm install em fonte monoespaçada, como <code> |
| Crase dentro do código | ``Use `git` here`` | O código Use `git` here. Envolva-o em mais crases do que ele contém |
| Bloco de código | ```
npm install
npm run dev
``` | Um bloco, <pre><code>, com as quebras de linha mantidas |
| Realce de sintaxe | ```python
def greet(name):
return f"Hello, {name}"
``` | Um bloco Python com a sintaxe colorida. Nomes comuns: js, ts, python, bash, json, html, css, sql |
| Cerca de tils | ~~~js
console.log("hi");
~~~ | O mesmo que uma cerca de crases |
| Código recuado | const total = 42; | Um bloco de código feito com 4 espaços de recuo, depois de uma linha em branco |
| Bloco diff | ```diff
- const x = 1;
+ const x = 2;
``` | Linhas removidas em vermelho e adicionadas em verde no GitHub |
| Cerca dentro de um bloco | ````markdown
```js
let a = 1;
```
```` | Um bloco que mostra a cerca interna como texto. A cerca externa precisa de mais crases que a interna |
Tabelas
Uma extensão do GitHub Flavored Markdown. A segunda linha, a linha delimitadora, transforma a primeira em cabeçalho. Ela precisa ter o mesmo número de células que o cabeçalho, senão nenhuma tabela é criada.
| Elemento | Markdown | Resultado |
|---|---|---|
| Tabela | | Name | Role |
| ----- | ------ |
| Ada | Admin |
| Linus | Editor | | Uma tabela com uma linha de cabeçalho e duas linhas |
| Alinhamento das colunas | | Left | Center | Right |
| :--- | :----: | ----: |
| a | b | c | | Os dois-pontos definem o alinhamento: à esquerda, centralizado, à direita |
| Sem barras nas pontas | Name | Role
--- | ---
Ada | Admin | A mesma tabela. As barras no início e no fim da linha são opcionais |
| Largura das colunas | | a | b |
|---|---|
| 1 | 2 | | As larguras vêm do conteúdo. A quantidade de hífens não importa, e as barras não precisam ficar alinhadas |
| Formatação nas células | | Command | Does |
| --- | --- |
| `git status` | Shows **changed** files | | Código, negrito, links e imagens funcionam dentro das células |
| Barra vertical dentro de uma célula | | Operator | Meaning |
| --- | --- |
| `a \| b` | a or b | | A célula mostra a | b. Escape a barra como \|, mesmo dentro de código |
| Quebra de linha numa célula | | Step | Notes |
| --- | --- |
| 1 | First line<br>Second line | | Duas linhas numa célula. Uma quebra de linha de verdade terminaria a linha da tabela |
| Células mescladas | <td colspan="2">Both columns</td> | Tabelas Markdown não mesclam células. Escreva a tabela em HTML com colspan ou rowspan |
Citações
Comece cada linha com >. Uma citação pode conter qualquer outro Markdown.
| Elemento | Markdown | Resultado |
|---|---|---|
| Citação | > Simple is better than complex. | Uma citação recuada, <blockquote> |
| Vários parágrafos | > First paragraph.
>
> Second paragraph. | Uma citação com dois parágrafos. A linha só com > os mantém juntos |
| Citação aninhada | > The reply
>> The original message | Uma citação dentro de outra |
| Outros elementos dentro | > #### Note
> - Back up first
> - Then upgrade | Um título e uma lista dentro da citação |
| Alerta (GitHub) | > [!NOTE]
> Requires Node 20 or later. | Uma caixa Note colorida no GitHub. Os outros tipos são [!TIP], [!IMPORTANT], [!WARNING] e [!CAUTION] |
Linhas horizontais
Três ou mais hífens, asteriscos ou underscores sozinhos numa linha desenham uma linha de lado a lado da página.
| Elemento | Markdown | Resultado |
|---|---|---|
| Linha | --- | Uma linha horizontal, <hr> |
| Outras formas | ***
___ | Mais duas linhas |
| Linha depois de texto | Some text
--- | Um parágrafo e depois uma linha. Mantenha a linha em branco |
| Linha em branco faltando | Some text
--- | Um título de nível 2, não uma linha: --- debaixo de uma linha de texto a sublinha |
Notas de rodapé
Funcionam no GitHub, no GitLab e em muitos geradores de sites estáticos. O CommonMark estrito não tem notas de rodapé.
| Elemento | Markdown | Resultado |
|---|---|---|
| Nota de rodapé | Markdown dates from 2004.[^1]
[^1]: John Gruber created it, with Aaron Swartz. | Um 1 sobrescrito que leva à nota, listada no fim da página |
| Nota com nome | See the spec.[^spec]
[^spec]: https://spec.commonmark.org | Os rótulos podem ser palavras, mas as notas continuam numeradas 1, 2, 3 na ordem de uso |
| Onde definir | [^1]: The text of the note. | A definição pode ficar em qualquer lugar do arquivo. Ela sempre aparece no final |
Escape de caracteres
Uma barra invertida antes de um caractere de pontuação imprime o próprio caractere em vez de formatar.
| Elemento | Markdown | Resultado |
|---|---|---|
| Asteriscos literais | \*not italic\* | Texto comum com os asteriscos: *not italic* |
| Cerquilha literal | \# Not a heading | Um parágrafo que começa com # |
| Número e ponto | 2024\. A good year. | Um parágrafo, não uma lista que começa em 2024 |
| Colchetes literais | \[not a link\](page.md) | Os colchetes e parênteses como foram digitados |
| Crase literal | \` | Uma crase |
| Barra invertida literal | \\ | Uma barra invertida |
| O que pode ser escapado | \ ` * _ {} [] () <> # + - . ! | | Qualquer pontuação ASCII. Uma barra invertida antes de uma letra ou de um dígito continua sendo uma barra invertida |
| Entidades HTML | © 2026 & <div> | © 2026 & <div>, como texto |
| Sem escape dentro de código | `*stars*` | O código *stars* como foi digitado. Dentro de código, a barra invertida é um caractere comum |
HTML dentro do Markdown
A maioria dos renderizadores deixa o HTML passar, então uma tag cobre o que o Markdown não tem como escrever. O GitHub remove HTML inseguro, como <script>, <style>, <iframe> e atributos style.
| Elemento | Markdown | Resultado |
|---|---|---|
| Teclas do teclado | Press <kbd>Ctrl</kbd> + <kbd>C</kbd> | Ctrl e C desenhadas como teclas |
| Subscrito e sobrescrito | H<sub>2</sub>O and x<sup>2</sup> | H₂O and x² |
| Seção recolhível | <details>
<summary>Show the answer</summary>
The answer is **42**.
</details> | Uma seção que abre com um clique. As linhas em branco deixam o Markdown de dentro ser renderizado |
| Markdown num bloco HTML | <div>
**not bold**
</div> | **not bold** como foi digitado. O Markdown não é lido dentro de um bloco HTML até uma linha em branco encerrar o bloco |
| Texto colorido | <span style="color: red">red</span> | Texto vermelho nos sites que permitem estilos inline. O GitHub remove o atributo style |
Comentários
Markdown não tem sintaxe de comentário. Dois truques mantêm um texto fora da página renderizada.
| Elemento | Markdown | Resultado |
|---|---|---|
| Comentário oculto | [//]: # (This line is never shown) | Nada. A linha é uma definição de link que nenhum link usa, então nunca chega ao HTML |
| Forma alternativa | [comment]: <> (Also hidden) | Nada, pelo mesmo truque |
| Comentário HTML | <!-- TODO: add screenshots --> | Nada na página, mas o comentário fica no código-fonte HTML |
| Comentário de várias linhas | <!--
This whole block
is hidden
--> | Nada na página |
| Posição | Some text.
[//]: # (comment)
More text. | Dois parágrafos. A linha do comentário precisa de uma linha em branco antes, senão aparece como texto |
GitHub Flavored Markdown e extras do GitHub
O GitHub Flavored Markdown (GFM) é o CommonMark mais tabelas, listas de tarefas, texto riscado e links de URL solta. O GitHub acrescenta mais recursos por cima.
| Recurso | Markdown | Onde funciona |
|---|---|---|
| Tabelas | | a | b |
| --- | --- |
| 1 | 2 | | GFM: GitHub, GitLab e a maioria das ferramentas de documentação |
| Listas de tarefas | - [x] Done | GFM |
| Riscado | ~~text~~ | GFM |
| Links de URL solta | www.coddy.tech | GFM |
| Código com linguagem | ```js
let a = 1;
``` | CommonMark e GFM. As cores vêm do site |
| Notas de rodapé | Text.[^1]
[^1]: Note. | GitHub e GitLab, embora não estejam na especificação GFM |
| Emoji | :rocket: :tada: | O GitHub e o GitLab transformam shortcodes em emoji |
| Menções | @octocat | GitHub: cria um link para o usuário e o notifica |
| Links de issues | #123 | GitHub: cria um link para a issue ou o pull request 123 no mesmo repositório |
| Diagramas | ```mermaid
graph LR
A --> B
``` | O GitHub e o GitLab desenham um diagrama Mermaid |
| Matemática | $E = mc^2$
$$
\sum_{i=1}^{n} i
$$ | O GitHub renderiza matemática em LaTeX, inline entre sinais $ e em bloco entre linhas $$ |
Toda a sintaxe de Markdown numa página só, ao lado do que cada linha vira. Esta folha de consulta cobre a sintaxe básica (títulos, ênfase, quebras de linha, listas, links, imagens, código, citações) e os extras do GitHub Flavored Markdown: tabelas com alinhamento, listas de tarefas, texto riscado, links de URL solta e notas de rodapé, além de escape de caracteres, HTML e comentários.
Os exemplos seguem o CommonMark e o GitHub Flavored Markdown, as regras em que o GitHub, o GitLab e a maioria das ferramentas de documentação se baseiam. Quando um site se comporta de outro jeito, a linha avisa. Para ver qualquer exemplo renderizado enquanto você digita, cole no editor de Markdown.
Perguntas frequentes sobre Markdown
Como fazer uma tabela em Markdown?
Escreva a linha de cabeçalho com as células entre barras verticais, depois uma linha delimitadora de hífens, depois uma linha para cada linha da tabela:
| Name | Role |, | --- | --- |, | Ada | Admin |. Dois-pontos na linha delimitadora alinham uma coluna: :--- à esquerda, :---: centralizado, ---: à direita. Tabelas são um recurso do GitHub Flavored Markdown, então funcionam no GitHub, no GitLab e na maioria das ferramentas de documentação, mas não no CommonMark estrito.Como pular uma linha em Markdown?
Uma quebra de linha simples dentro de um parágrafo é ignorada no resultado. Para forçar a quebra, termine a linha com dois espaços ou uma barra invertida (
\), ou escreva <br>. Para começar um novo parágrafo, deixe uma linha em branco. Issues e comentários do GitHub são a exceção: ali uma única quebra de linha já aparece como quebra.Como escrever um comentário em Markdown?
Markdown não tem sintaxe de comentário, mas dois truques funcionam.
[//]: # (your comment) numa linha própria, com uma linha em branco antes, é uma definição de link que nada usa, então nunca chega à página nem ao HTML. Um comentário HTML, <!-- your comment -->, também fica oculto na página, mas continua no código-fonte HTML, onde qualquer pessoa que veja o código-fonte consegue lê-lo.Como fazer um bloco de código em Markdown?
Coloque três crases na linha antes do código e três na linha depois. Adicione o nome de uma linguagem depois das crases de abertura, como em
```python, para ter realce de sintaxe. Para código no meio de uma frase, envolva-o em crases simples: `npm install`.Como adicionar uma checkbox em Markdown?
Comece um item de lista com
[ ] para uma caixa vazia ou [x] para uma marcada: - [ ] Review ou - [x] Draft. Mantenha o espaço dentro dos colchetes vazios. Checkboxes fazem parte do GitHub Flavored Markdown, e em issues e pull requests do GitHub dá para marcá-las com um clique.Como mudar o tamanho de uma imagem em Markdown?
Markdown puro não tem sintaxe de tamanho:
 sempre mostra a imagem no tamanho original. Use uma tag HTML, como <img src="image.png" alt="alt text" width="300">, que o GitHub e a maioria dos renderizadores aceitam. Defina só a largura ou só a altura para manter as proporções.Como criar um link para um título em Markdown?
Aponte para o ID do título com
#: [Setup](#getting-started) salta para ## Getting Started. O GitHub monta o ID a partir do texto do título em minúsculas, com os espaços trocados por hífens e a pontuação removida, exceto hífens e underscores. Para um título em outro arquivo, coloque o ID depois do nome do arquivo: [Setup](docs/install.md#getting-started).O que é um arquivo .md?
Um arquivo de texto puro escrito em Markdown.
.md e .markdown são as extensões usuais, e README.md é o arquivo que o GitHub mostra na página inicial de um repositório. Qualquer editor de texto abre um; o GitHub, sites de documentação e visualizadores de Markdown o renderizam como texto formatado. Para ver um arquivo renderizado enquanto você o edita, cole no editor de Markdown.Recursos relacionados
Mais folhas de consulta
