Intégrer un encart#

Cette page détaille comment intégrer et customiser un encart ("admonition" dans la langue de Beyoncé) : syntaxes, icônes, titres ...etchétera etchétera

Par "encart" on fait référence à une balise qui ressemble par exemple à cela :

Utiles pour ajouter des infos supplémentaires, des avertissement ou pour plein d'autres raisons permettant d'alléger et marquer des pauses dans la rédaction, ces encarts peuvent être de plusieurs nature et se déclarent comme ceci :

!!! tip "ceci est un encart de type 'tip' hihi"
    texte de l'encart

Après les trois points d'exclamation vient le type de l'encart. Les valeurs possibles sont listées ici.

Personnaliser le titre de l'encart#

Il est possible de mettre son propre texte entre guillemets pour donner un titre à l'encart. Un double guillemet vide donnera un encart sans titre :

Rendre l'encart dépliable#

Pour un encart dépliable, c'est trois points d'interrogation qu'on utilisera, avec un + pour dire si l'encart est déplié par défaut :

MarkdownRendu

??? question "Quelle est la différence entre un lapin :rabbit: et un pneu ?"
    Ils sont tous les deux en caoutchouc, sauf le lapin !

Quelle est la différence entre un lapin et un pneu ?

Ils sont tous les deux en caoutchouc, sauf le lapin !

Alignement de l'encart#

Pour aligner un encart à droite, on utilise les mots-clés inline end, comme ceci :

!!! info inline end "Lorem ipsum"
    Lorem ipsum dolor sit amet, et patati et patata

Pour aligner l'encart à gauche, ce sera seulement le mot-clé inline.

Gérer les encarts multilignes et indentés comme un pro#

La syntaxe des encarts peut entrer en conflit avec le vérificateur du Markdown qui génère alors des faux positifs, notamment dans 2 cas de figure assez communs :

• les encarts contenant un texte à plusieurs lignes ;
• les encarts indentés par exemple dans les onglets.

Il faut alors encadrer l'encart (j'étais obligé de faire cette formulation, c'est contractuel) avec les balises désactivant la règle 46 du linter. Voilà ce que cela donne :

<!-- markdownlint-disable MD046 -->
!!! example "Je, je suis multiligne"
    Je suis un faux positif  
    Je, je suis si fragile  
    Qu'on me désactive

    Fendre la lune, baisers d'épine et de plume  
    Bercée par un petit vent, je déambule  
    La vie est triste comme un verre de grenadine  
    Aimer c'est pleurer quand on s'incline
<!-- markdownlint-enable MD046 -->

Commentaires