Guia rápido de Markdown/MyST#

Este arquivo contém a sintaxe para as marcações Markdown e MyST mais comuns.
Abra-o no seu editor de texto para copiar e colar rapidamente o que precisar.

Veja o guia de estilo do MyST para informações e convenções detalhadas.

Veja também a documentação do MyST para mais detalhes, e o Guia de Estilo da Canonical para convenções gerais de estilo.

Título H2#

Título H3#

Título H4#

Título H5#

Formatação inline#

Elemento da interface
código
comando
Tecla
Itálico
Negrito

Blocos de código#

Inicie um bloco de código:

code:
  - example: true

# Exemplo de bloco de código

code:

* example: true

# Exemplo de bloco de código
code:
  - example: true

Links#

Navegação#

Use a seguinte sintaxe::

    ```{toctree}
    :hidden:

    sub-page1
    sub-page2
    ```

Listas#

Etapa 1
- Item 1
  - Subitem
- Item 2
  1. Subetapa 1
  2. Subetapa 2
Etapa 2
1. Subetapa 1
  - Item
2. Subetapa 2

Termo 1: Definição
Termo 2: Definição

Tabelas#

Tabelas Markdown#

Cabeçalho 1	Cabeçalho 2
Célula 1 Segundo parágrafo	Célula 2
Célula 3	Célula 4

Centralizado:

Cabeçalho 1	Cabeçalho 2
Célula 1 Segundo parágrafo	Célula 2
Célula 3	Célula 4

Tabelas com list-table#

Cabeçalho 1

Cabeçalho 2

Célula 1

Segundo parágrafo

Célula 2

Célula 3

Célula 4

Centralizado:

Cabeçalho 1

Cabeçalho 2

Célula 1

Segundo parágrafo

Célula 2

Célula 3

Célula 4

Notas#

Nota

Uma nota.

Dica

Uma dica.

Importante

Informação importante.

Cuidado

Isso pode danificar seu hardware!

Imagens#

Legenda da figura#

Reutilização#

Chaves#

As chaves podem ser definidas no início de um arquivo ou na opção myst_substitutions no conf.py.

Por exemplo, se você escrever:

Veremos o emoji do gato {{gato}} e do camelo {{camelo}}.

Você obterá:

Veremos o emoji do gato 🐈 e do camelo 🐫.

Abas#

Conteúdo da Aba 1

Glossário#

termo #: Definição do termo de exemplo.

termo

Mais marcações úteis#

Adicionado na versão X.Y.
API

Extensões personalizadas#

Um link para um vídeo do YouTube: