Ir para o conteúdo

Markdown e Comandos Mkdocs

← Voltar ao guia

Markdown

Títulos

Título 1

Título 2

Título 3

# Título 1

## Título 2

### Título 3

Formatação de texto

Negrito

Itálico

Tachado

código inline

Negrito: 

**texto**
Itálico: 
*texto*
Tachado: 
~~texto~~
Código inline: 
`texto`

Listas

  • Item A

  • Item B

    • Subitem

  • Primeiro

  • Segundo

Lista com marcadores: 

- Item A
- Item B
    - Subitem
Lista numerada: 
1. Primeiro
2. Segundo

Trilha Dev

[Texto do link](https://url.com)

Imagens

Texto da imagem

Imagem local (recomendado): 

![Descrição](../assets/imagens/logo.png)
Imagem por URL externa: 
![Descrição](https://exemplo.com/imagem.png)

Imagem local

Salve a imagem dentro do projeto em docs/assets/imagens/ e referencie com caminho relativo. Funciona offline e não depende de links externos.

Imagem externa

Links de URL podem parar de funcionar se o endereço mudar ou a rede restringir acesso externo.

Blocos de código

nome = input("Qual seu nome? ")
print(f"Olá, {nome}!")

```python
nome = input("Qual seu nome? ")
print(f"Olá, {nome}!")
```

Tabelas

Comando O que faz
git add Adiciona ao stage
git commit Registra alterações 
| Coluna 1 | Coluna 2 |
|----------|----------|
| valor    | valor    |

Admonitions

Dica

Texto da dica.

Atenção

Texto de alerta.

Informação

Texto informativo.

!!! tip "Dica"
    Texto da dica.

!!! warning "Atenção"
    Texto de alerta.

!!! info "Informação"
    Texto informativo.

Abas

print("Olá!")

echo "Olá!"

=== "Python"
    ```python
    print("Olá!")
    ```
=== "Terminal"
    ```bash
    echo "Olá!"
    ```

Comandos MkDocs

Inicia o servidor local com preview em tempo real: 

mkdocs serve

Servidor local

Após rodar o comando, acesse http://127.0.0.1:8000 no navegador.

Gera o site estático na pasta site/: 

mkdocs build

Publica o site: 

mkdocs gh-deploy