2. Caixas de Alerta

As caixas de alerta servem para destacar informações essenciais, avisos, ou dicas importantes, quebrando o fluxo normal do texto e chamando a atenção do leitor.

2.1. Tipos Mais Usados

Estes são os tipos que você usará com maior frequência para orientar o leitor em situações de risco, informação ou otimização.

2.1.1. Note

Usado para informações importantes, mas neutras.

Exemplo de Sintaxe:

!!! note "Lembrete: Versões Suportadas"
    Esta funcionalidade só está disponível para usuários com **Python versão 3.10 ou superior**. Versões anteriores podem causar erros de dependência.

2.1.2. Warning

Usado para alertar sobre algo que pode dar errado ou causar problemas, mas que não é crítico.

Exemplo de Sintaxe:

!!! warning "Atenção ao Formato"
    Certifique-se de que o nome do arquivo `config.yaml` está em letras minúsculas. O sistema é **case-sensitive** e não reconhecerá `Config.yaml`.

2.1.3. Tip

Usado para sugerir melhores práticas, atalhos, ou formas mais eficientes de fazer algo.

Exemplo de Sintaxe:

!!! tip "Dica de Otimização de Desempenho"
    Para reduzir o tempo de compilação em 30%, utilize a flag `--fast-build` ao invés de `-b`.

2.1.4. Danger

Usado para alertar sobre perigos extremos, perda de dados ou falhas de segurança. Use com moderação.

Exemplo de Sintaxe:

!!! danger "Risco de Dados"
    **NUNCA** execute o comando `DELETE-ALL` em um ambiente de produção. Isso resultará na perda irrecuperável de todos os dados do banco.

2.2. Mais Opções Úteis

Estes tipos são ótimos para dar feedback visual, resumir conteúdo ou fazer referências cruzadas.

2.2.1. Success

Indica que uma etapa ou processo foi concluído com sucesso.

Exemplo de Sintaxe:

!!! success "Instalação Concluída!"
    Se você seguiu os passos corretamente, a mensagem "Setup complete" deve aparecer no seu terminal.

2.2.2. Abstract

Usado no início de uma seção longa para dar um resumo rápido (muitas vezes chamado de "TL;DR" - Too Long; Didn't Read).

Exemplo de Sintaxe:

!!! abstract "Resumo Rápido da Seção"
    Esta seção explica a diferença entre autenticação por Token e por Chave API. Requer conhecimento básico de redes.

2.2.3. Seealso

Usado para indicar onde o leitor pode encontrar informações relacionadas.

Exemplo de Sintaxe:

!!! seealso "Referência"
    Para configurar a rede manualmente, consulte o capítulo "Configurações de Rede".

2.3. Tipos Menos Comuns

Estes são mais específicos e geralmente usados em documentação de API ou de bibliotecas de código.

2.3.1. Versionadded

Indica a versão do software em que um recurso foi introduzido.

Exemplo de Sintaxe:

!!! versionadded "Novo na Versão 2.1"
    O novo módulo `api.v2` foi adicionado, substituindo o antigo `api.legacy`.

2.3.2. Example

Usado para ilustrar um trecho de código ou um caso de uso, se o bloco de código padrão não for suficiente.

Exemplo de Sintaxe:

!!! example
    Abaixo está um exemplo de como a função `calculate()` deve ser chamada com parâmetros nomeados:

    ```python
    resultado = calculate(valor=100, moeda='BRL')
    ```