| title | 11. Comment utiliser les blocs Mintlify (notes, warnings, tips) |
|---|
Les blocs Mintlify permettent de mettre en valeur certaines informations.
Ils rendent vos pages plus lisibles, plus pédagogiques et plus professionnelles.
Ils sont parfaits pour attirer l’attention sur un point important.
Les blocs les plus utilisés sont :
-
les notes
-
les avertissements
-
les conseils
-
les informations importantes
Ils permettent de structurer visuellement votre contenu.
Mintlify propose plusieurs styles de blocs :
Elles servent à ajouter une information complémentaire ou un rappel utile.
Ils attirent l’attention sur un risque, une erreur fréquente ou une mauvaise pratique.
Ils donnent une astuce, une bonne pratique ou une recommandation.
Elles mettent en avant un point essentiel que le lecteur doit retenir.
Chaque bloc a un rôle précis et doit être utilisé avec cohérence.
Voici quelques repères simples :
-
utilisez une note pour clarifier un détail
-
utilisez un warning pour prévenir une erreur
-
utilisez un tip pour donner un conseil utile
-
utilisez une info importante pour un point clé
L’objectif est d’aider le lecteur, pas de surcharger la page.
-
n’utilisez pas trop de blocs dans une seule page
-
gardez les messages courts et directs
-
choisissez le bon type de bloc selon le contexte
-
évitez de mettre plusieurs blocs à la suite
-
utilisez-les pour guider le lecteur, pas pour décorer
Un bloc doit toujours avoir une raison d’être.
-
utiliser un warning pour une simple remarque
-
mettre trop d’informations dans un bloc
-
répéter la même idée dans plusieurs blocs
-
utiliser un bloc pour remplacer un paragraphe
Les blocs doivent compléter le texte, pas le remplacer.
Les blocs Mintlify permettent de mettre en valeur les informations importantes.
Bien utilisés, ils rendent votre documentation plus claire, plus lisible et plus professionnelle.
-
Documentation Mintlify : https://mintlify.com/docs
-
Exemples de blocs : https://mintlify.com/templates