Les Avertissements¶
Utilisation¶
Les avertissements suivent une syntaxe simple : un bloc commence par !!!, suivi d'un seul mot-clé utilisé comme qualificateur de type. Le contenu du bloc suit à la ligne suivante, indenté de quatre espaces :
!!! note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor
massa, nec semper lorem quam in massa.
Note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Modifier le titre¶
Par défaut, le titre sera égal au qualificateur de types. Cependant, il peut être changé en ajoutant une chaîne de caractères entre guillemets contenant du Markdown valide (y compris des liens, du formatage, ...) après le qualificateur de type :
!!! note "Phasellus posuere in sem ut cursus"
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor
massa, nec semper lorem quam in massa.
Phasellus posuere in sem ut cursus
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Supprimer le titre¶
Semblable à modifier le titre, l'icône et le titre peuvent être entièrement omis en ajoutant une chaîne vide directement après le qualificateur de type. Notez que cela ne fonctionnera pas pour les blocs rétractables :
!!! note ""
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor
massa, nec semper lorem quam in massa.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Blocs rétractables¶
Lorsque qu'un bloc d'admonition commence par ??? au lieu de !!!, l'admonition est rendue comme un bloc rétractable avec un petit basculeur sur le côté droit :
??? note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor
massa, nec semper lorem quam in massa.
Note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
L'ajout d'un + après le token ??? rend le bloc développé par défaut :
???+ note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor
massa, nec semper lorem quam in massa.
Note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Blocs aligné¶
Les avertissements peuvent également être rendues comme des blocs alignés (par exemple, pour les barres latérales), en les plaçant à droite en utilisant les modificateurs inline + end, ou à gauche en utilisant uniquement le modificateur inline :
Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
!!! info inline end "Lorem ipsum"
Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Nulla et euismod nulla.
Curabitur feugiat, tortor non consequat
finibus, juste purus auctor massa, nec
semper lorem quam in massa.
Utilisez inline end pour aligner à droite (gauche pour les langues rtl).
Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
!!! info inline "Lorem ipsum"
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
euismod nulla.
Curabitur feugiat, tortor non consequat
finibus, juste purus auctor massa, nec
semper lorem quam in massa.
Utilisez inline pour aligner à gauche (droite pour les langues rtl).
Important : les avertissements qui utilisent les modificateurs inline doivent être déclarées avant le bloc de contenu avec lequel vous souhaitez les placer à côté. S'il n'y a pas assez d'espace pour rendre l'admonition à côté du bloc, l'admonition s'étendra sur toute la largeur de la fenêtre d'affichage, par exemple, sur les fenêtres d'affichage mobiles.
Types supportés¶
Voici une liste des qualificateurs de type fournis par Material pour MkDocs, tandis que le type par défaut, et donc de repli pour les qualificateurs de type inconnus, est note:
Note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Abstract
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Info
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Tip
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Success
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Question
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Warning
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Failure
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Danger
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Bug
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Example
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Quote
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, juste purus auctor massa, nec semper lorem quam in massa.
Source¶
-
Consultez la documentation officielle de Material pour MkDocs pour plus d'informations sur l'utilisation et la personnalisation des admonitions.