Passer au contenu principal
Utilisez ces paramètres dans votre fichier docs.json pour contrôler l’architecture de l’information et l’expérience utilisateur de votre site. Modifiez la barre de navigation, le pied de page, les bannières, le comportement de navigation, les menus contextuels, les redirections et les variables de contenu globales.

​
Paramètres

Type : object La structure de navigation de votre contenu. C’est ici que vous définissez la hiérarchie complète des pages de votre site en utilisant des groupes, des onglets, des menus déroulants, des ancres et plus encore. Voir Navigation pour la documentation complète sur la construction de votre structure de navigation.
​
navigation.global
object
Éléments de navigation globaux qui apparaissent sur toutes les pages et locales.
​
navigation.languages
array of object
Sélecteur de langue pour les sites multilingues. Chaque entrée peut inclure des configurations banner, footer et navbar spécifiques à la langue, en plus de la structure de navigation.
​
navigation.versions
array of object
Sélecteur de versions pour les sites avec plusieurs versions.
​
navigation.tabs
array of object
Onglets de navigation de niveau supérieur.
​
navigation.anchors
array of object
Ancres de la barre latérale.
​
navigation.dropdowns
array of object
Menus déroulants pour regrouper le contenu connexe.
​
navigation.products
array of object
Sélecteur de produits pour les sites avec plusieurs produits.
​
navigation.groups
array of object
Groupes pour organiser le contenu en sections.
​
navigation.pages
array of string or object
Pages individuelles qui composent votre documentation.
​
navigation.directory
string
défaut:"none"
Disposition de répertoire pour les pages racines de groupe. Définissez sur "accordion" ou "card" pour afficher une liste de pages enfants sur les pages racines de groupe. Définissez sur "none" pour désactiver. S’hérite récursivement ; les descendants peuvent remplacer cette valeur. Consultez Listes de répertoire pour plus d’informations.
Type : object Liens et boutons affichés dans la barre de navigation supérieure.
​
navbar.links
array of object
Liens à afficher dans la barre de navigation.
​
navbar.primary
object
Bouton d’appel à l’action principal dans la barre de navigation.
docs.json
"navbar": {
  "links": [
    { "type": "github", "href": "https://github.com/your-org/your-repo" },
    { "label": "Communauté", "href": "https://example.com/community" }
  ],
  "primary": {
    "type": "button",
    "label": "Commencer",
    "href": "https://example.com/signup"
  }
}
Type : object Contenu du pied de page et liens vers les réseaux sociaux.
​
footer.socials
object
Profils de réseaux sociaux à afficher dans le pied de page. Chaque clé est un nom de plateforme et chaque valeur est l’URL de votre profil.Clés valides : x, website, facebook, youtube, discord, slack, github, linkedin, instagram, hacker-news, medium, telegram, twitter, x-twitter, earth-americas, bluesky, threads, reddit, podcast
"socials": {
  "x": "https://x.com/yourhandle",
  "github": "https://github.com/your-org"
}
​
footer.links
array of object
Colonnes de liens affichées dans le pied de page. Maximum 4 colonnes.
docs.json
"footer": {
  "socials": {
    "x": "https://x.com/yourhandle",
    "github": "https://github.com/your-org"
  },
  "links": [
    {
      "header": "Entreprise",
      "items": [
        { "label": "Blog", "href": "https://example.com/blog" },
        { "label": "Carrières", "href": "https://example.com/careers" }
      ]
    }
  ]
}
Type : object Une bannière globale affichée en haut de chaque page.
​
banner.content
string
requis
Le contenu textuel affiché dans la bannière. Prend en charge le formatage MDX de base, y compris les liens, le texte en gras et en italique. Les composants personnalisés ne sont pas pris en charge.
"content": "Nous venons de lancer quelque chose de nouveau. [En savoir plus](https://example.com)"
​
banner.dismissible
boolean
Indique s’il faut afficher un bouton de fermeture pour que les utilisateurs puissent fermer la bannière. Valeur par défaut : false.
docs.json
"banner": {
  "content": "Nous venons de lancer quelque chose de nouveau. [En savoir plus](https://example.com)",
  "dismissible": true
}

​
interaction

Type : object Contrôle le comportement d’interaction utilisateur pour les éléments de navigation.
​
interaction.drilldown
boolean
Contrôle la navigation automatique lors de la sélection d’un groupe de navigation. Définissez sur true pour naviguer automatiquement vers la première page lorsqu’un groupe se développe. Définissez sur false pour uniquement développer ou réduire le groupe sans naviguer. Laissez non défini pour utiliser le comportement par défaut du thème.

​
contextual

Type : object Le menu contextuel donne aux utilisateurs un accès rapide aux outils IA et aux actions de page. Il apparaît dans l’en-tête de la page ou dans la barre latérale de la table des matières.
Le menu contextuel est uniquement disponible sur les déploiements de prévisualisation et de production.
​
contextual.options
array
requis
Actions disponibles dans le menu contextuel. La première option du tableau apparaît comme action par défaut.Options intégrées :
  • "add-mcp" — Ajouter votre serveur MCP à la configuration de l’utilisateur
  • "aistudio" — Envoyer la page actuelle à Google AI Studio
  • "assistant" — Ouvrir l’assistant IA avec la page actuelle comme contexte
  • "copy" — Copier la page actuelle au format Markdown dans le presse-papiers
  • "chatgpt" — Envoyer la page actuelle à ChatGPT
  • "claude" — Envoyer la page actuelle à Claude
  • "cursor" — Installer votre serveur MCP hébergé dans Cursor
  • "devin" — Envoyer la page actuelle à Devin
  • "devin-mcp" — Installer votre serveur MCP hébergé dans Devin
  • "grok" — Envoyer la page actuelle à Grok
  • "mcp" — Copier l’URL de votre serveur MCP dans le presse-papiers
  • "perplexity" — Envoyer la page actuelle à Perplexity
  • "view" — Afficher la page actuelle au format Markdown dans un nouvel onglet
  • "vscode" — Installer votre serveur MCP hébergé dans VS Code
  • "windsurf" — Envoyer la page actuelle à Windsurf
Définissez des options personnalisées sous forme d’objets :
​
contextual.display
"header" | "toc"
Où afficher les options contextuelles. Choisissez header pour les afficher dans le menu contextuel en haut de la page, ou toc pour les afficher dans la barre latérale de la table des matières. Valeur par défaut : header.
docs.json
"contextual": {
  "options": ["copy", "view", "chatgpt", "claude"],
  "display": "header"
}

​
redirects

Type : array of object Redirections pour les pages déplacées, renommées ou supprimées. Utilisez-les pour préserver les liens lorsque vous réorganisez votre contenu.
​
redirects[].source
string
requis
Le chemin source à partir duquel rediriger. Exemple : /old-page
​
redirects[].destination
string
requis
Le chemin de destination vers lequel rediriger. Exemple : /new-page
​
redirects[].permanent
boolean
Si true, émet une redirection permanente (308). Si false, émet une redirection temporaire (307). Valeur par défaut : true.
docs.json
"redirects": [
  {
    "source": "/old-page",
    "destination": "/new-page"
  },
  {
    "source": "/temp-redirect",
    "destination": "/destination",
    "permanent": false
  }
]

​
errors

Type : object Paramètres personnalisés de la page d’erreur.
​
errors.404
object
Paramètres pour la page d’erreur 404 « Page non trouvée ».
docs.json
"errors": {
  "404": {
    "redirect": false,
    "title": "Page non trouvée",
    "description": "La page que vous recherchez n'existe pas. [Retour à l'accueil](/)."
  }
}

​
variables

Type : object Variables globales à utiliser dans toute votre documentation. Mintlify remplace les espaces réservés {{variableName}} par les valeurs définies au moment de la compilation.
​
variables.[variableName]
string
Une paire clé-valeur où la clé est le nom de la variable et la valeur est le texte de remplacement.
  • Les noms de variables peuvent contenir des caractères alphanumériques et des tirets.
  • Vous devez définir toutes les variables référencées dans votre contenu, sinon la compilation échoue.
  • Mintlify assainit les valeurs pour prévenir les attaques XSS.
docs.json
"variables": {
  "version": "2.0.0",
  "api-url": "https://api.example.com"
}
Dans votre contenu, référencez les variables avec des doubles accolades : 
La version actuelle est {{version}}. Envoyez des requêtes à {{api-url}}.

​
metadata

Type : object Paramètres de métadonnées au niveau de la page appliqués globalement.
​
metadata.timestamp
boolean
Active une date de dernière modification sur toutes les pages. Lorsqu’elle est activée, les pages affichent la date de la dernière modification du contenu. Valeur par défaut : false.Vous pouvez remplacer ce paramètre sur des pages individuelles en utilisant le champ frontmatter timestamp. Voir Pages pour plus de détails.
docs.json
"metadata": {
  "timestamp": true
}