Guia de sintaxe Markdown
Um guia rápido e claro para o Markdown do dia a dia. Cada bloco mostra a sintaxe e o resultado que você obtém.
O que é Markdown?
Markdown é um jeito leve de acrescentar formatação a texto puro. Em vez de botões e menus, você usa alguns símbolos simples, como # para um título ou * para ênfase, que continuam legíveis mesmo como texto original.
Criado por John Gruber e Aaron Swartz em 2004, tornou-se o padrão para READMEs, documentação, anotações e sites como GitHub e Reddit. Como é só texto, o que você escreve fica portátil e legível em qualquer lugar.
Este guia cobre a sintaxe que você mais vai usar. Abra qualquer exemplo no Markdown Peek e pressione a barra de espaço para alternar entre o código-fonte e o resultado.
Títulos
Comece uma linha com de um a seis caracteres #. Quanto mais #, menor 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
Envolva o texto em símbolos para enfatizá-lo. Combine-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
Use um hífen, um asterisco ou um sinal de mais para marcadores, e números para listas ordenadas. Recue 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
Links
Coloque o texto visível entre colchetes e o endereço entre parênteses. Um endereço web ou de e-mail simples vira um link por conta própria.
Markdown
[Markdown Peek](https://markdownpeek.com) https://markdownpeek.com
Imagens
Uma imagem é um link precedido de um ponto de exclamação. O texto entre colchetes é o texto alternativo.
Markdown
Resultado
Citações
Comece uma linha com > para citá-la. Acrescente 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
Envolva o código no texto em crases simples, e blocos inteiros em três crases. Acrescente 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
Separe as colunas com barras verticais e sublinhe a linha do cabeçalho com hífens. 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ífens, asteriscos ou sublinhados em uma linha só desenham um divisor.
Markdown
Above the line. --- Below the line.
Resultado
Above the line.
Below the line.
Listas de tarefas
Um item de lista com [ ] é uma tarefa em aberto, e [x] é uma tarefa concluída.
Markdown
- [x] Read the guide - [ ] Set as default app
Resultado
Destaques
Comece uma citação com [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] ou [!CAUTION] para transformá-la em um 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é
Acrescente [^1] onde a nota deve aparecer e escreva a nota em qualquer lugar mais abaixo. O Markdown Peek numera as notas, lista-as no final e leva de volta ao ponto onde você estava.
Front matter
Pares de chave e valor entre duas linhas --- bem no topo de um arquivo, como em posts de blog e skills de agentes, aparecem como uma tabela organizada.
Markdown
--- title: Lofoten author: Sam tags: travel --- # Five nights in March
Resultado
| title | author | tags |
|---|---|---|
| Lofoten | Sam | travel |
Five nights in March
Escapando caracteres
Coloque uma barra invertida antes de um símbolo para exibi-lo literalmente em vez de como formatação.
Markdown
\*Not italic\* \# Not a heading
Resultado
*Not italic*
# Not a heading
Fórmulas com LaTeX
Envolva o LaTeX em cifrões simples para matemática dentro de uma frase, ou em cifrões duplos para uma fórmula em uma linha própria. O Markdown Peek renderiza 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
Abra um bloco de código delimitado com mermaid e descreva um fluxograma ou diagrama de sequência em texto puro. O Markdown Peek o desenha para você, no modo claro ou escuro.
Markdown
```mermaid flowchart LR A[Write] --> B[Preview] B --> C[Share] ```
Resultado
Leia Markdown com capricho no seu Mac
O Markdown Peek renderiza qualquer arquivo .md em um estilo GitHub limpo, com código colorido, Visualização Rápida no Finder e PDF. Grátis na Mac App Store.
