Les Annotations¶
Utilisation¶
Les annotations se composent de deux parties : un marqueur, qui peut être placé n'importe où dans un bloc marqué avec la classe annotate, et un contenu situé dans une liste en dessous du bloc contenant le marqueur.
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: Je suis une annotation ! Je peux contenir du `code`, du texte __formaté__, des images, ... en gros tout ce qui peut être exprimé en Markdown.
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
Je suis une annotation ! Je peux contenir du code, du texte formaté, des images, ... en gros tout ce qui peut être exprimé en Markdown.
Notez que la classe annotate doit être ajoutée uniquement au bloc le plus externe. Tous les éléments imbriqués peuvent utiliser la même liste pour définir des annotations, sauf lorsque les annotations sont elles-mêmes imbriquées.
dans les annotations¶
Lorsque SuperFences est activé, les annotations peuvent être imbriquées à l'intérieur d'autres annotations en ajoutant la classe annotate à l'élément de liste hébergeant le contenu de l'annotation, en répétant le processus :
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: I'm an annotation! (1)
{ .annotate }
1. :woman_raising_hand: I'm an annotation as well!
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
-
Je suis une annotation ! (1)
Je suis aussi une annotation !
dans les avertissements¶
Les titres et les corps des avertissements peuvent également accueillir des annotations en ajoutant le modificateur annotate après le qualificateur de type, ce qui est similaire à la façon dont fonctionnent les [blocs en ligne] :
!!! note annotate "Phasellus posuere in sem ut cursus (1)"
Lorem ipsum dolor sit amet, (2) consectetur adipiscing elit. Nulla et
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.
1. :man_raising_hand: Je suis une annotation !
2. :woman_raising_hand: Je suis aussi une annotation !
Phasellus posuere in sem ut cursus (1)
Lorem ipsum dolor sit amet, (2) consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
- Je suis une annotation !
- Je suis aussi une annotation !
dans les onglets de contenu¶
Les onglets de contenu peuvent accueillir des annotations en ajoutant la classe annotate au bloc d'un onglet de contenu dédié (et non au conteneur, ce qui n'est pas pris en charge) :
=== "Tab 1"
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: Je suis une annotation !
=== "Tab 2"
Phasellus posuere in sem ut cursus (1)
{ .annotate }
1. :woman_raising_hand: Je suis aussi une annotation !
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
- Je suis aussi une annotation !
Phasellus posuere in sem ut cursus (1)
- Je suis aussi une annotation !
dans tout le reste¶
L'extension [Attribute Lists] est l'ingrédient clé pour ajouter des annotations à la plupart des éléments, mais elle a certaines [limitations]. Cependant, il est toujours possible d'exploiter l'extension [Markdown in HTML] pour envelopper des éléments arbitraires avec un div avec la classe annotate :
<div class="annotate" markdown>
> Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
</div>
1. :man_raising_hand: Je suis aussi une annotation !
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
- Je suis aussi une annotation !
Avec cette astuce, des annotations peuvent également être ajoutées aux citations, listes, et à de nombreux autres éléments qui ne sont pas pris en charge par l'extension Listes d'attributs. De plus, notez que les blocs de code suivent des sémantiques différentes.
Source¶
-
Consultez la documentation officielle de Material pour MkDocs pour plus d'informations sur l'utilisation et la personnalisation des annotations.