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 :
attention il y a un éléphant rose dans le ciel !!
Nan nan, c'est pas vrai
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
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 :
Ceci est un encart de type question et sans titre (donc sans question)... Bah je sais pas moi... 12 ?
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 :
??? 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
Lorem ipsum
Lorem ipsum dolor sit amet, et patati et patata
Pour aligner l'encart à gauche, ce sera seulement le mot-clé inline
.
placement de l'encart
Un encart aligné à droite ou à gauche doit être placé avant le bloc avec lequel il s'aligne.
-
étape où un contributeur propose d'intégrer ses modifications dans le socle principal du projet. Voir la documentation de GitHub. ↩
Commentaires
Ce contenu est sous licence Creative Commons BY-NC-SA 4.0 International