menu

Sintaxe Estendida

Recursos avançados que se baseiam nos fundamentos do Markdown.

Visão geral

A sintaxe básica descrita no documento de design original de John Gruber adicionou muitos dos elementos necessários no dia a dia, mas não foi suficiente para algumas pessoas. É aí que entra a sintaxe estendida.

Vários indivíduos e organizações decidiram estender a sintaxe básica adicionando mais elementos, como tabelas, blocos de código, realce de sintaxe, vinculação automática de URL e notas de rodapé. Esses elementos podem ser ativados usando uma linguagem de marcação leve baseada na sintaxe do Markdown ou adicionando uma extensão a um processador Markdown compatível.

Disponibilidade

Nem todos os aplicativos Markdown suportam elementos de sintaxe estendidos. Você precisará verificar se a linguagem de marcação leve que seu aplicativo está usando suporta os elementos adicionais que você deseja usar. Caso contrário, ainda será possível ativar extensões no seu processador Markdown.

Linguagens de marcação leves

Existem várias linguagens de marcação leves que são variações do Markdown. Elas se baseiam na sintaxe do Gruber e adicionam alguns elementos, como tabelas, blocos de código, realce de sintaxe, vinculação automática de URL e notas de rodapé. Muitos dos aplicativos Markdown mais populares usam uma das seguintes linguagens de marcação leves:

CommonMark 

Markdown com sabor do GitHub (GFM) 

Markdown Extra 

MultiMarkdown 

R Markdown 

Processadores de Markdown

Existem dezenas de processadores Markdown disponíveis. Muitos deles permitem adicionar extensões que ativam elementos de sintaxe estendidos. Consulte a documentação do seu processador para obter mais informações.

Tabelas

Para adicionar uma tabela, use três ou mais hifens --- para criar o cabeçalho e use a barra vertical | para separar cada coluna. Como opção, você pode adicionar barras invertidas nas duas extremidades da tabela.

| Sintaxe     | Descrição   |
| ----------- | ----------- |
| Cabeçalho   | Título      |
| Parágrafo   | Texto       |

A saída renderizada fica assim:

Sintaxe Descrição
Cabeçalho Título
Parágrafo Texto

As larguras das células podem variar, como mostrado abaixo. A saída renderizada terá a mesma aparência.

| Sintaxe | Descrição |
| --- | ----------- |
| Cabeçalho | Título |
| Parágrafo | Texto |

Dica: Criar tabelas com hifens e tubos pode ser entediante. Para acelerar o processo, tente usar o Gerador de tabelas Markdown . Crie uma tabela usando a interface gráfica e copie o texto no formato Markdown gerado para o seu arquivo.

Alinhamento

O texto das colunas pode ser alinhado à esquerda, direita ou centro adicionando dois pontos : à esquerda, direita ou nos dois lados dos hifens na linha do cabeçalho.

| Sintaxe      | Descrição | Texto teste |
| :---         |  :----:   |        ---: |
| Cabeçalho    | Título    | Aqui está   |
| Parágrafo    | Texto     | E mais      |

A saída renderizada fica assim:

Sintaxe Descrição Texto teste
Cabeçalho Título Aqui está
Parágrafo Texto E mais

Formatação de texto em tabelas

Você pode formatar o texto nas tabelas. Por exemplo, você pode adicionar links, dar ênfase, adicionar código (palavras ou frases entre crases ` somente, não é possível adicionar blocos de código).

Você não pode adicionar títulos, blocos de citação, listas, linhas horizontais, imagens ou tags HTML.

Escapando barras verticais em tabelas

Você pode exibir um caractere de barra vertical | em uma tabela usando o código HTML (|).

Bloco de código cercado

A sintaxe básica do Markdown permite criar blocos de código recuando linhas em quatro espaços ou uma tabulação. Se você achar isso inconveniente, tente usar blocos de códigos cercados. Dependendo do seu processador ou editor Markdown, você usará três crases (```) ou três tiles (~~~) nas linhas antes e depois do bloco de código. A melhor parte? Você não precisa recuar nenhuma linha!

```
{
  "nome": "Robert",
  "sobrenome": "Salles",
  "idade": 25
}
```
A saída renderizada fica assim:
{
  "nome": "Robert",
  "sobrenome": "Salles",
  "idade": 25
}

Dica: Precisa exibir crases dentro de um bloco de código? Clique aqui para aprender como escapá-las.

Realce de sintaxe

Muitos processadores Markdown oferecem suporte a realce de sintaxe para blocos de código cercados. Esse recurso permite adicionar realce de cores para qualquer linguagem de programação em que o seu código foi escrito. Para adicionar realce de sintaxe, especifique o nome da linguagem ao lado das crases antes do bloco de código cercado.

```json
{
  "nome": "Robert",
  "sobrenome": "Salles",
  "idade": 25
}
```

A saída renderizada fica assim:

{
  "nome": "Robert",
  "sobrenome": "Salles",
  "idade": 25
}

Notas de rodapé

As notas de rodapé permitem adicionar notas e referências sem sobrecarregar o corpo do documento. Quando você cria uma nota de rodapé, um número sobrescrito com um link aparece onde você adicionou a referência da nota. Os leitores podem clicar no link e ir diretamente para o conteúdo de referência na parte inferior da página.

Para criar uma referência de nota de rodapé, adicione um acento circunflexo e um identificador entre colchetes ([^1]). Identificadores podem ser números ou palavras, mas não podem conter espaços ou tabulações. Os identificadores correlacionam apenas a referência da nota de rodapé com a própria nota - na saída renderizada, as notas de rodapé são numeradas sequencialmente.

Adicione a nota de rodapé usando outro acento circunflexo e o número entre colchetes com dois pontos e texto ([^1]: Minha nota de rodapé.). Você não precisa colocar notas de rodapé no final do documento. Você pode colocá-los em qualquer lugar, exceto dentro de outros elementos, como listas, blocos de citação e tabelas.

Aqui está uma nota de rodapé simples,[^1] e aqui está uma mais longa.[^bignote]

[^1]: Esta é a primeira nota de rodapé.

[^bignote]: Aqui está uma com vários parágrafos e código.

    Recuar parágrafos para incluí-los na nota de rodapé.

    `{ meu código }`

    Adicione quantos parágrafos desejar.

A saída renderizada fica assim:

Aqui está uma nota de rodapé simples,1 e aqui está uma mais longa.2

  1. Esta é a primeira nota de rodapé.

  2. Aqui está um com vários parágrafos e código.

    Recuar parágrafos para incluí-los na nota de rodapé.

    { meu código }

    Adicione quantos parágrafos desejar.

IDs do título

Muitos processadores Markdown suportam IDs personalizados para títulos - alguns processadores Markdown os adicionam automaticamente. Adicionar IDs personalizados permite que você crie vinculação diretamente com os títulos e os modifique usando CSS. Para adicionar um ID de título personalizado, coloque-o entre chaves na mesma linha, logo após o conteúdo do título.

### Meu título {#identificacao}

O HTML fica assim:

<h3 id="identificacao">Meu título</h3>

Vinculando a códigos de cabeçalho

Você pode criar um vinculo com um título dentro do seu documento usando a sintaxe padrão de link, porém dentro dos parenteses preceda a identificação com um sinal de número/cerquilha (#).

Markdown HTML Resultado
[IDs de cabeçalho](#id-titulo) <a href="#id-titulo">IDs de cabeçalho</a> IDs de cabeçalho

Para vincular a um ID de título vindo de outra página adicione o link complete seguido da cerquilha e a identificação do título (exemplo: [IDs de cabeçalho](https://markdown.net.br/sintaxe-estendida#id-titulo)).

.

Lista de definições

Alguns processadores Markdown permitem criar listas de termos e suas definições correspondentes. Para criar uma lista de definições, digite o termo na primeira linha, insira uma quebra com Enter, digite dois pontos seguidos por um espaço e a definição.

Primeiro termo
: Esta é a definição do primeiro termo.

Segundo termo
: Esta é uma definição do segundo termo.
: Esta é outra definição do segundo termo.

O HTML fica assim:

<dl>
  <dt>Primeiro termo</dt>
  <dd>Esta é a definição do primeiro termo.</dd>
  <dt>Segundo termo</dt>
  <dd>Esta é uma definição do segundo termo. </dd>
  <dd>Esta é outra definição do segundo termo.</dd>
</dl>

A saída renderizada fica assim:

Primeiro termo
Esta é a definição do primeiro termo.
Segundo termo
Esta é uma definição do segundo termo.
Esta é outra definição do segundo termo.

Riscado

Você pode tachar ou riscar palavras, ou seja, colocar uma linha horizontal no centro delas. Dessa forma. Esse recurso permite que você indique que certas palavras são um erro que não se destina à inclusão no documento. Para riscar palavras, use dois símbolos de tiles (~~) antes e depois do conteúdo.

~~A terra é plana.~~ Agora sabemos que a terra é ~~redonda~~ um geóide.

A saída renderizada fica assim:

A terra é plana. Agora sabemos que a terra é redonda um geóide.

Listas de tarefas

As listas de tarefas permitem criar uma lista de itens com caixas de seleção. Nos aplicativos Markdown compatíveis com listas de tarefas, as caixas de seleção serão exibidas ao lado do conteúdo. Para criar uma lista de tarefas, adicione traços (-) e colchetes com um espaço ([ ]) na frente dos itens da lista de tarefas. Para selecionar uma caixa de seleção, adicione um x entre os colchetes ([x]).

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

A saída renderizada fica assim:

Markdown task list

Emojis

Existem duas maneiras de adicionar emoticons aos arquivos do Markdown: copie e cole o emoji no texto formatado no Markdown ou digite códigos de emoji.

Copiando e colando Emoji

Na maioria dos casos, você pode simplesmente copiar um emoji de uma fonte como Emojipedia e colá-lo em seu documento. Muitos aplicativos Markdown exibem automaticamente o emoji no texto no formato Markdown. Os arquivos HTML e PDF que você exporta do aplicativo Markdown devem exibir o emoji.

Dica: Se você estiver usando um gerador de site estático, codifique as páginas HTML como UTF-8.

Usando códigos de acesso Emoji

Alguns aplicativos Markdown permitem inserir emoticons digitando códigos de acesso emoji. Eles começam e terminam com dois pontos : e incluem o nome de um emoji.

Fui acampar! :tent: Volto em breve.

Isso é tão engraçado! :joy:

A saída renderizada fica assim:

Fui acampar! ⛺ Volto em breve.

Isso é tão engraçado! 😂

Obs: Você pode usar esta lista de códigos de acesso emoji, mas lembre-se de que os códigos de emoji variam de aplicativo para aplicativo. Consulte a documentação do seu aplicativo Markdown para obter mais informações.

Muitos processadores Markdown transformam URLs automaticamente em links. Isso significa que, se você digitar https://markdown.net.br, o processador Markdown o transformará automaticamente em um link, mesmo que você não tenha usado colchetes.

https://markdown.net.br

A saída renderizada fica assim:

https://markdown.net.br

Se você não deseja que um URL seja vinculado automaticamente, é possível remover o link denotando o URL como código usando crases.

`https://markdown.net.br`

A saída renderizada fica assim:

https://markdown.net.br