Exemplos de uso de recursos do Mkdocs

Cabeçalhos

Notação:

# H1
## H2
### H3
#### H4

Negrito

Notação:

**bold text**

Resultado: bold text

Itálico

Notação:

*italicized text*

Resultado: italicized text

Bloco de citação

Notação:

> blockquote some text

Resultado:

blockquote some text

Listas ordenadas

Notação:

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

Resultado:

First item
Second item
Third item

Listas não ordenadas

Notação:

- Primeiro item
- Segundo item
- Terceiro item

Resultado:

Primeiro item
Segundo item
Terceiro item

Código

Notação:

`Essa é uma linha de código`

Resultado:

Essa é uma linha de código

Linha horizontal

Notação:

---

Resultado:

Link

Notação:

[Markdown Guide](https://www.markdownguide.org)

Resultado:

Markdown Guide

Imagem

Notação:

![alt text](https://www.markdownguide.org/assets/images/tux.png)

Resultado:

alt text

Tabela

Notação:

| 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:

```
{
  "nome": "José",
  "email": "jose@net.com ",
  "age": 25
}
```

Resultado:

{
  "nome": "José",
  "email": "jose@net.com ",
  "age": 25
}

Lista de definições

Notação:

termo
: definição

Resultado:

termo : definição

Taxado

Notação:

~~A terra é plana.~~

Resultado:

~~A terra é plana.~~

Destaque

Notação:

Eu preciso destacar estas ==palavras muito importantes==.

Resultado:

Eu preciso destacar estas palavras muito importantes.

Subscrito

Notação:

H~2~O

Resultado:

H₂O

Sobrescrito

Notação:

X^2^

Resultado:

X²

Diagramas (Mermaid)

Notação:

```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:

:smile: :+1: :tada: :rocket: :metal: 🤖

Resultado:

🤖

Lista de tarefas

Notação:

- [ ] Tarefa 1
- [ ] Tarefa 2
- [ ] Tarefa 3
- [ ] Tarefa 4

Resultado:

Tarefa 1
Tarefa 2
Tarefa 3
Tarefa 4

Caixa de aviso

Notação:

!!! warning "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:

!!! note "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:

!!! tip "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:

!!! tip "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.