Bannière

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 masquées par l’utilisateur. Elles utilisent la couleur définie par la propriété colors.dark dans votre docs.json. Pour ajouter une bannière, utilisez la propriété banner dans votre docs.json :

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

"banner": {
  "content": "⚠️ Maintenance planifiée : l’API sera indisponible le 15 décembre, de 2 h à 4 h UTC",
  "dismissible": false
}

"banner": {
  "content": "**Action requise :** migrez vers notre nouvelle version d’ici le 1er janvier. [Guide de migration](/migration)",
  "dismissible": true
}

Propriétés

string

requis

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

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.

Bannières spécifiques à chaque langue

Configurez un contenu de bannière différent pour chaque langue de votre documentation. Définissez ces bannières spécifiques à chaque langue dans le tableau navigation.languages de votre fichier docs.json.

{
  "navigation": {
    "languages": [
      {
        "language": "en",
        "banner": {
          "content": "🚀 La version 2.0 est en ligne ! Consultez notre [journal des modifications](/en/changelog) pour plus de détails.",
          "dismissible": true
        },
        "groups": [
          {
            "group": "Premiers pas",
            "pages": ["en/overview", "en/quickstart"]
          }
        ]
      },
      {
        "language": "es",
        "banner": {
          "content": "🚀 ¡La versión 2.0 ya está disponible! Consulta nuestro [registro de cambios](/es/changelog) para más detalles.",
          "dismissible": true
        },
        "groups": [
          {
            "group": "Premiers pas",
            "pages": ["es/overview", "es/quickstart"]
          }
        ]
      }
    ]
  },
  "banner": {
    "content": "🚀 La version 2.0 est en ligne !",
    "dismissible": true
  }
}

Comportement de repli

Les bannières suivent un ordre de priorité pour déterminer quel contenu afficher :

Bannière spécifique à une langue : Si la langue actuelle dispose d’une configuration banner, celle-ci est prioritaire.
Bannière globale : Si aucune bannière spécifique à une langue n’existe, la banner globale est affichée.

Premiers pas

Organiser

Personnaliser

Créer du contenu

Documenter les API

Déployer

Optimiser

Propriétés

Bannières spécifiques à chaque langue

Comportement de repli

​Propriétés

​Bannières spécifiques à chaque langue

​Comportement de repli

Propriétés

Bannières spécifiques à chaque langue

Comportement de repli