Alertes

Certaines phrases ne doivent pas se lire comme de la prose. Un avertissement au milieu d'un paragraphe est un avertissement que personne ne lit.

Les six types

note, info et alert complètent l'ensemble. Sans type, un bloc est une note ; avec un title, le libellé du type cède la place à vos mots.

<Admonition type="danger" title="Ce que coûte un faux pas">
  Supprimer une version retire ses pages du site.
</Admonition>

À vous : un type qui vous ressemble

Six types ne conviendront pas à toutes les équipes. Déclarez celui dont la vôtre a besoin — un libellé, et un ton qui porte la couleur :

// docpensieve.config.mjs
admonitions: {
  review: { label: 'À relire', tone: 'attention' },
  legal: { label: 'Mention légale', tone: 'info' },
},

<Admonition type="review">Cette section attend une seconde paire d'yeux.</Admonition>

Le ton vient du thème : un nouveau type ne demande donc aucune feuille de style et suit les schémas clair et sombre tout seul. Un type que personne n'a déclaré arrête la génération, en listant ceux qui existent — rendu quand même, le bloc sortirait sans couleur ni libellé, et rien ne dirait pourquoi.

Une marque à soi

Un type peut porter une icône à la place du dessin de son ton. Ce site même en déclare deux, avec leur marque prise dans un jeu d'icônes :

admonitions: {
  copilot: { label: 'Copilot', tone: 'info', icon: 'simple-icons:githubcopilot' },
},

npm install --save-dev @iconify-json/simple-icons

Le jeu est un paquet de votre projet, lu à la génération : le dessin est posé dans la page comme un fichier à vous. Votre lecteur ne télécharge rien, et aucune requête ne part de son navigateur — c'est aussi pourquoi un jeu que vous n'avez pas installé arrête la génération au lieu de laisser un carré vide.

Vérifiez par vous-même

Bravo

Vous avez terminé À votre main. Le site porte désormais vos couleurs, votre navigation et vos avertissements.