Markdown - Admonition¶

Os Admonition são elementos visuais utilizados para destacar partes de uma página. São apresentados na forma de "Caixas" com um titulo, em destaque, e um conteúdo associado. Algumas destas caixas podem ser "recolhidas" de forma que apenas o título fique visível.

A seguir temos um exeplo de uso do elemento Admonition

sudo systemctl list-unit-files | grep snap | grep enable

A Extensão Admonition¶

Esta extensão adiciona a possibilidade de utilizamos blocos de texto estilizados, que podem ser utilizados para destacar determinadas partes do conteúdo da página.

Para mais informações sobre esta extensão consulte o site: python-markdown.

Ativando a extensão¶

Para ativar esta extensão devemos adicionar na seção markdown_extensions do arquivo mkdocs.yml, a seguinte linha:

1
2

markdown_extensions:
   - admonition

Após adicionar este linha podemos reiniciar o serviço do MkDocs.

Utilizando a extensão¶

A sintaxe para utilizar este extensão é bem simples. Todo bloco começa com !!! ou com ===???===, seguindo de um espaço e do tipo do bloco. O conteúdo do bloco começa na linha a seguir e deve estar indentado por 4 espaços. A seguir temos um exemplo de código:

!!! note
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

Este código gera um bloco semelhante à:

Para alterar o título do bloco devemos utilizar

!!! note "Novo Título"

Para remover o título podemos utilizar:

!!! note ""

Podemos inserir um bloco dobrável (collapsible) trocando os sinais de exclamações (!)por sinais de interrogação (?). Por exemplo:

??? note
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

Este código gera um bloco semelhante à:

Adicionando um sinal de + logo após aos sinais de ? o bloco aparecerá, por padrão, aberto. Por exemplo:

???+ note
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

Este código gera um bloco semelhante à:

A extensão Admonition suporta vários tipos de qualificadores definidos pelos usuários. Quando esta extensão é combinada ao tema Material, ela suporta os seguintes tipos:

• Notas : note, ou seealso (Comando)

• Abstract : abstract, summary ou tldr

• Informação : info ou todo (Configuração)

• Dica : tip, hint, important

• Sucesso : success, check ou done (Saida)

• Pergunta : question, help ou faq

• Aviso : warning, caution ou attention (Erro)

• Falha : failure, fail ou missing

• Perigo : danger ou error

• Bug : bug

• Exemplo : example

• Citação : quote ou cite

Refencias¶

• Mais informações consulte este link

Comentários