Guia de sintaxe Markdown
Uma folha de consulta clara para o Markdown do dia a dia. Cada bloco mostra a sintaxe e o resultado que obténs.
O que é o Markdown?
O Markdown é uma forma leve de acrescentar formatação a texto simples. Em vez de botões e menus, usas alguns símbolos simples, como # para um título ou * para ênfase, que continuam legíveis mesmo como texto em bruto.
Criado por John Gruber e Aaron Swartz em 2004, tornou-se o padrão para READMEs, documentação, notas e sites como o GitHub e o Reddit. Como é só texto, a tua escrita fica portátil e legível em qualquer lado.
Este guia cobre a sintaxe que mais vais usar. Abre qualquer exemplo no Markdown Peek e prime a barra de espaço para alternares entre o código-fonte e o resultado.
Títulos
Começa uma linha com um a seis caracteres #. Quantos mais #, mais pequeno e mais profundo é o título.
Markdown
# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4
Resultado
Heading 1
Heading 2
Heading 3
Heading 4
Negrito, itálico e mais
Envolve o texto em símbolos para o enfatizar. Combina-os à vontade.
Markdown
**Bold text** *Italic text* ***Bold and italic*** ~~Strikethrough~~ `Inline code`
Resultado
Bold text
Italic text
Bold and italic
Strikethrough
Inline code
Listas
Usa um hífen, um asterisco ou um sinal de mais para marcadores, e números para listas ordenadas. Indenta para aninhar.
Markdown
- First item - Second item - Nested item - Third item 1. Step one 2. Step two
Resultado
- First item
- Second item
- Nested item
- Third item
- Step one
- Step two
Ligações
Põe o texto visível entre parênteses retos e o endereço entre parênteses curvos. Um endereço web ou de email simples torna-se uma ligação por si só.
Markdown
[Markdown Peek](https://markdownpeek.com) https://markdownpeek.com
Imagens
Uma imagem é uma ligação precedida de um ponto de exclamação. O texto entre parênteses retos é o texto alternativo.
Markdown
Resultado
Citações
Começa uma linha com > para a citar. Acrescenta outro > para aninhar uma citação dentro de outra.
Markdown
> A quote worth remembering. > > > And a nested one.
Resultado
A quote worth remembering.
And a nested one.
Código
Envolve o código em linha em acentos graves simples, e blocos inteiros em três acentos graves. Acrescenta o nome de uma linguagem e o Markdown Peek colore o código, como o GitHub.
Markdown
Use `backticks` for inline code.
```js
function hi() {
console.log("Hello");
}
```Resultado
Use backticks for inline code.
function hi() {
console.log("Hello");
}Tabelas
Separa as colunas com barras verticais e sublinha a linha do cabeçalho com hífenes. Os dois pontos definem o alinhamento.
Markdown
| Feature | Supported | |---------|:---------:| | Tables | Yes | | Code | Yes |
Resultado
| Feature | Supported |
|---|---|
| Tables | Yes |
| Code | Yes |
Linhas horizontais
Três ou mais hífenes, asteriscos ou sublinhados numa linha própria desenham um separador.
Markdown
Above the line. --- Below the line.
Resultado
Above the line.
Below the line.
Listas de tarefas
Um item de lista com [ ] é uma tarefa por fazer, e [x] é uma tarefa concluída.
Markdown
- [x] Read the guide - [ ] Set as default app
Resultado
Destaques
Começa uma citação com [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] ou [!CAUTION] para a transformar num destaque colorido, como no GitHub.
Markdown
> [!NOTE] > Useful to know, even when skimming. > [!WARNING] > Needs attention right away.
Resultado
Note
Useful to know, even when skimming.
Warning
Needs attention right away.
Notas de rodapé
Acrescenta [^1] onde a nota deve aparecer e escreve a nota em qualquer ponto mais abaixo. O Markdown Peek numera as notas, lista-as no fim e liga de volta ao sítio onde estavas.
Front matter
Pares de chave e valor entre duas linhas --- mesmo no topo de um ficheiro, como em artigos de blogue e skills de agentes, aparecem como uma tabela arrumada.
Markdown
--- title: Lofoten author: Sam tags: travel --- # Five nights in March
Resultado
| title | author | tags |
|---|---|---|
| Lofoten | Sam | travel |
Five nights in March
Escapar caracteres
Põe uma barra invertida antes de um símbolo para o mostrares tal como é, em vez de formatação.
Markdown
\*Not italic\* \# Not a heading
Resultado
*Not italic*
# Not a heading
Matemática com LaTeX
Envolve o LaTeX em cifrões simples para matemática dentro de uma frase, ou em cifrões duplos para uma fórmula numa linha própria. O Markdown Peek apresenta ambos, offline.
Markdown
Inline math like $E = mc^2$ works in a sentence. $$ a^2 + b^2 = c^2 $$
Resultado
Inline math like E = mc2 works in a sentence.
a2 + b2 = c2
Diagramas com Mermaid
Abre um bloco de código delimitado com mermaid e descreve um fluxograma ou diagrama de sequência em texto simples. O Markdown Peek desenha-o por ti, no modo claro ou escuro.
Markdown
```mermaid flowchart LR A[Write] --> B[Preview] B --> C[Share] ```
Resultado
Lê Markdown com todo o cuidado no teu Mac
O Markdown Peek apresenta qualquer ficheiro .md num estilo GitHub limpo, com código a cores, Vista rápida no Finder e PDF. Grátis na Mac App Store.
