Exemplos de uso de recursos do Mkdocs

Cabeçalhos

Notação: ```md

H1

H2

H3

H4

```

Negrito

Notação: md **bold text** Resultado: bold text

Itálico

Notação: md *italicized text* Resultado: italicized text

Bloco de citação

Notação: ```md

blockquote some text ``` Resultado: blockquote some text

Listas ordenadas

Notação: md 1. First item 2. Second item 3. Third item Resultado:

1. First item
2. Second item
3. Third item

Listas não ordenadas

Notação: md - Primeiro item - Segundo item - Terceiro item Resultado:

• Primeiro item
• Segundo item
• Terceiro item

Código

Notação: md `Essa é uma linha de código` Resultado:

Essa é uma linha de código

Linha horizontal

Notação: ```md

---

``` Resultado:

---

Link

Notação: md [Markdown Guide](https://www.markdownguide.org) Resultado:

Markdown Guide

Imagem

Notação: md ![alt text](https://www.markdownguide.org/assets/images/tux.png) Resultado:

Tabela

Notação: md | Nome | e-mail | |-----------|---------------| | José | jose@net.com | | Maria | maria@net.com | Resultado:

Nome	e-mail
José	jose@net.com
Maria	maria@net.com

Bloco de código

Notação: md ``` { "nome": "José", "email": "jose@net.com ", "age": 25 } ``` Resultado: { "nome": "José", "email": "jose@net.com ", "age": 25 }

Lista de definições

Notação: ```md termo : definição

``` Resultado:

termo : definição

Taxado

Notação: md ~~A terra é plana.~~ Resultado:

A terra é plana.

Destaque

Notação: md Eu preciso destacar estas ==palavras muito importantes==. Resultado:

Eu preciso destacar estas palavras muito importantes.

Subscrito

Notação: md H~2~O Resultado:

H<sub>2</sub>O

Sobrescrito

Notação: md X^2^ Resultado:

X<sup>2</sup>

Diagramas (Mermaid)

Notação: ````md

```mermaid flowchart . --> A

A --> B
A --> C
A --> D
A --> E

```

````

Resultado:

flowchart
    . --> A

    A --> B
    A --> C
    A --> D
    A --> E

emojis

Notação: md :smile: :+1: :tada: :rocket: :metal: 🤖 Resultado:

🤖

Lista de tarefas

Notação: md - [ ] Tarefa 1 - [ ] Tarefa 2 - [ ] Tarefa 3 - [ ] Tarefa 4

Resultado:

• Tarefa 1
• Tarefa 2
• Tarefa 3
• Tarefa 4

Caixa de aviso

Notação: ```md

Título do aviso

Algum texto de aviso aqui. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

```

Resultado:

Título do aviso

Algum texto de aviso aqui. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

Caixa de Nota

Notação: ```md

Título da Nota

Alguma nota sobre o conteúdo. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

```

Resultado:

Título da Nota

Alguma nota sobre o conteúdo. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

Caixa de Dica

Notação: ```md

Título da Dica

Alguma dica sobre o conteúdo. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

```

Resultado:

Título da Dica

Alguma dica sobre o conteúdo. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

Caixa de Alerta

Notação: ```md

Título do Alerta

Algum alerta sobre o conteúdo. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

```

Resultado:

Título do Alerta

Algum alerta sobre o conteúdo. Apenas um exemplo. Mais uma linha de texto. Outra linha de texto.

Macros

Testando o uso de macros em arquivos markdown: Teste de macro. Esse texto veio de uma macro.

Templates

---

Todo esse bloco de texto veio de um template

Apenas demonstrando o uso de templates.
Esse bloco de texto pode ser usado em qualquerf parte da documentação.
1. Linha 1
2. Linha 2
3. Linha1 3

O texto do template termina aqui.

---