Referência de sintaxe

Sintaxe do Markdown: os padrões que você usará com mais frequência

Você pode escrever Markdown útil com um pequeno conjunto de padrões. Comece pela estrutura semântica, deixe linhas em branco ao redor dos elementos de bloco e pré-visualize o documento no renderizador onde ele será publicado.

Leitura de 8 minutos

Títulos e parágrafos

Prefixa um título com um a seis caracteres de cerquilha (#). Use um H1 para o título do documento e, em seguida, desça pelos níveis sem escolher títulos apenas pelo tamanho visual. Os parágrafos são separados por uma linha em branco.

TítulosMarkdown
# Document title

An opening paragraph.

## Installation

Setup details.

### Environment variables

Configuration details.

Ênfase, links e imagens

Use asteriscos para ênfase, colchetes para o texto visível do link e parênteses para o destino. A sintaxe de imagem acrescenta um ponto de exclamação; um texto alternativo significativo continua importante quando a imagem não pode ser vista.

Sintaxe em linhaMarkdown
Use **bold** for strong importance and *italic* for emphasis.

Read the [deployment guide](/guides/deploy).

![A diagram of the request flow](request-flow.png)

Listas e listas de tarefas

Comece itens não ordenados com um hífen e itens ordenados com um número. Recue itens aninhados de forma consistente. Muitas plataformas para desenvolvedores também suportam caixas de seleção de listas de tarefas por meio do GitHub Flavored Markdown.

ListasMarkdown
- Prepare the release
  - Update the changelog
  - Freeze migrations
- Deploy

1. Start the canary
2. Watch metrics
3. Expand traffic

- [x] Tests pass
- [ ] Docs reviewed

Código em linha e blocos de código com cerca

Coloque identificadores ou comandos curtos entre crases simples. Coloque exemplos mais longos entre cercas de três crases e adicione o nome da linguagem quando o renderizador suportar realce de sintaxe. Mantenha exemplos executáveis completos o suficiente para entender e testar.

CódigoMarkdown
Set `SERVICE_URL` in the server environment.

```ts
type Result = {
  markdown: string;
  fileName: string;
};
```

Citações, linhas horizontais e tabelas

As citações em bloco (blockquotes) são úteis para material citado ou avisos curtos. Linhas horizontais separam grandes transições. Tabelas funcionam bem para dados compactos e retangulares; elas se tornam difíceis de ler quando as células contêm texto longo ou quando a tabela é muito larga.

Tabela GFMMarkdown
> Conversion preserves structure, not pixel-perfect layout.

---

| Format | Good for | Review |
| --- | --- | --- |
| DOCX | Styled prose | Tables |
| CSV | Small datasets | Escaping |

Escreva uma sintaxe que sobreviva a diferentes renderizadores

Deixe linhas em branco ao redor de títulos, listas, tabelas e blocos de código com cerca. Prefira links descritivos a URLs cruas. Evite HTML bruto, a menos que o sistema de publicação o suporte e higienize explicitamente. Quando um recurso for específico de uma plataforma, inclua texto simples suficiente para que o documento ainda faça sentido em outros lugares.

A pré-visualização mostra como o documento é renderizado aqui; seu repositório ou sistema de documentação de destino continua sendo o teste final de compatibilidade.

Pratique a sintaxe com pré-visualização em tempo real

Abra um rascunho local e veja títulos, listas, código e tabelas serem renderizados enquanto você digita.

Experimente o editor