O básico em uma tabela
O Markdown foi criado para que um arquivo de texto continue legível mesmo antes de ser convertido. Um título parece um título porque começa com uma cerquilha, e uma lista parece uma lista porque cada linha começa com um hífen. Quando o texto aparece no GitHub, em um aplicativo de notas ou no editor abaixo, as marcações viram formatação de verdade.
A tabela reúne as marcações que você vai usar com mais frequência. Copie qualquer exemplo para o editor e veja o que ele gera.
| Elemento | Escreva | Resultado |
|---|---|---|
| Título de nível 1 a 6 | # Título, ## Seção, ### Subseção | Títulos de tamanho decrescente |
| Negrito | **negrito** ou __negrito__ | texto em negrito |
| Itálico | *itálico* ou _itálico_ | texto em itálico |
| Negrito e itálico | ***ambos*** | texto em negrito e itálico |
| Tachado | ~~preço antigo~~ | texto riscado |
| Código na linha | `npm install` | código em fonte monoespaçada |
| Link | [Anyfeat](https://anyfeat.com) | texto clicável |
| Imagem |  | uma imagem com texto alternativo |
| Lista com marcadores | - item (ou * item, + item) | um marcador |
| Lista numerada | 1. primeiro | um item numerado |
| Lista de tarefas | - [ ] a fazer e - [x] feito | caixas de seleção |
| Citação | > texto citado | uma citação recuada |
| Linha horizontal | *** sozinho na linha | uma linha divisória |
Experimente aqui: Editor de Markdown
Abrir a página completa da ferramentaTítulos, parágrafos e quebras de linha
Comece uma linha com uma a seis cerquilhas seguidas de um espaço para criar um título; a quantidade de cerquilhas é o nível. A maioria dos documentos usa um título de nível 1 para o nome do documento e títulos de nível 2 e 3 para as seções. Esquecer o espaço depois da cerquilha é o erro mais comum: #Título continua como texto normal no GitHub.
Um parágrafo é uma ou mais linhas de texto separadas do parágrafo seguinte por uma linha em branco. Uma quebra de linha simples dentro de um parágrafo é ignorada quando o texto é convertido, o que surpreende muita gente. Para forçar uma quebra de linha, termine a linha com dois espaços ou com uma barra invertida. Os comentários do GitHub e alguns aplicativos de chat tratam cada quebra de linha como quebra; no editor acima, ative Quebras de linha como nos comentários do GitHub para ter o mesmo comportamento.
No GitHub e no editor acima, cada título também ganha uma âncora, uma versão do texto em letras minúsculas com os espaços trocados por hífens. Um título chamado Primeiros passos pode ser linkado com [ver instalação](#primeiros-passos), e é assim que funcionam os sumários dos arquivos README.
Listas e listas de tarefas
Listas com marcadores começam cada linha com um hífen, um asterisco ou um sinal de mais e um espaço. Listas numeradas usam um número e um ponto. Os números não precisam estar certos: uma lista escrita como 1. 1. 1. aparece mesmo assim como 1, 2, 3, mas o primeiro número conta, então uma lista que começa com 3. começa no 3.
Para aninhar uma lista, recue os itens internos para que fiquem alinhados com o texto do item de cima, ou seja, dois espaços sob um hífen e três sob 1. Quatro espaços também funcionam na maioria das ferramentas. Uma linha em branco entre os itens cria uma lista espaçada, com mais distância entre eles; sem linhas em branco a lista fica compacta.
Listas de tarefas são um recurso do GitHub: escreva - [ ] para uma tarefa aberta e - [x] para uma concluída. Elas viram caixas de seleção. No editor desta página você pode marcar uma caixa na pré-visualização e o [ ] do seu texto muda para [x].
Links, imagens e referências
Um link é o texto visível entre colchetes seguido do endereço entre parênteses: [Anyfeat](https://anyfeat.com). Um título que aparece ao passar o mouse vai entre aspas depois do endereço. Um endereço entre os sinais de menor e maior, como <https://anyfeat.com>, vira um link que mostra o próprio endereço, e no GitHub endereços soltos que começam com https:// ou www. viram link automaticamente.
Imagens usam o mesmo padrão com um ponto de exclamação na frente: . O texto entre colchetes é o texto alternativo lido pelos leitores de tela e mostrado quando a imagem não carrega, então descreva o que aparece na imagem.
Em documentos longos, links de referência deixam o texto mais legível: escreva [o guia][1] no texto e coloque [1]: https://example.com em uma linha própria em qualquer lugar do arquivo. A linha de definição não aparece no resultado.
Tabelas
Tabelas fazem parte do GitHub Flavored Markdown e funcionam no GitHub, no GitLab, na maioria das ferramentas de documentação e no editor acima, mas não em todo aplicativo de Markdown. Escreva as células do cabeçalho separadas por barras verticais, depois uma linha separadora com hífens e então uma linha por linha da tabela:
| Plano | Preço |, depois |:-|-:|, depois | Equipe | 49 |. Cada célula da linha separadora precisa de pelo menos um hífen; o comum é usar três, porque fica mais fácil de ler. Dois-pontos do lado esquerdo dos hífens alinham a coluna à esquerda, dois-pontos dos dois lados centralizam e dois-pontos do lado direito alinham à direita, o que combina com números.
As barras não precisam ficar alinhadas, e as barras das pontas são opcionais. Para colocar uma barra vertical dentro de uma célula, escreva \|. O Markdown em si não permite quebra de linha dentro de uma célula; use <br> onde HTML for aceito. O botão Tabela do editor insere uma tabela pronta com três colunas para você preencher.
Código e citações
Para um trecho curto de código dentro de uma frase, coloque-o entre crases simples: `git status`. Para várias linhas, coloque três crases na linha antes e na linha depois do código. Um nome de linguagem logo depois das crases de abertura, como js, python ou sql, permite que o GitHub e os realçadores coloram o código; o editor desta página o mantém como classe do elemento code no HTML exportado. Linhas recuadas com quatro espaços também aparecem como código.
Tudo o que está dentro do código aparece exatamente como foi digitado, então é o lugar certo para símbolos que o Markdown interpretaria de outro jeito, como asteriscos e sublinhados. Fora do código, coloque uma barra invertida antes de um símbolo para mostrá-lo como ele é: \* gera um asterisco comum.
Citações começam com > e podem conter outras marcações de Markdown, incluindo listas e citações dentro de citações com >>. Elas são usadas para citações, observações e respostas em discussões.
Diferenças entre aplicativos de Markdown
A sintaxe básica acima funciona em quase todo lugar. As diferenças estão nos recursos extras: o GitHub aceita tabelas, listas de tarefas, tachado, links automáticos e alertas escritos como > [!NOTE]; o Obsidian acrescenta links entre notas com colchetes duplos; algumas ferramentas aceitam notas de rodapé e fórmulas matemáticas. O editor desta página segue o GitHub em tabelas, listas de tarefas, tachado, links automáticos e âncoras de títulos, e não aceita notas de rodapé, fórmulas nem alertas.
A maioria dos aplicativos de Markdown também aceita um pouco de HTML. Tags como <br>, <sub>, <sup>, <kbd> e <details> funcionam no editor acima, enquanto scripts, estilos e atributos de eventos são sempre removidos, como no GitHub.