Bannière

Ajoutez une bannière pour afficher des annonces et des notifications importantes à l’échelle du site

Utilisez des bannières pour afficher des annonces, des mises à jour ou des notifications importantes sur l’ensemble de votre site de documentation. Les bannières apparaissent en haut de chaque page, prennent en charge la mise en forme Markdown et peuvent être rendues fermables.

Pour ajouter une bannière, utilisez la propriété banner dans votre docs.json :

Annonces produit

"banner": {
  "content": "🚀 La version 2.0 est désormais en ligne ! Consultez notre [journal des modifications](/changelog) pour plus de détails.",
  "dismissible": true 
}

​

Propriétés

content · string · requis

Message de la bannière. Prend en charge le texte brut et la mise en forme Markdown.

dismissible · boolean

Indique si les utilisateurs peuvent masquer la bannière. Lorsque true, ils peuvent fermer la bannière et elle ne réapparaît pas durant leur session. Valeur par défaut : false.