Structure du site

Configurez la barre de navigation, le pied de page, la bannière, les redirections et d'autres paramètres structurels dans docs.json.

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.globalobject

Éléments de navigation globaux qui apparaissent sur toutes les pages et locales.

Show navigation.global

tabsarray of object

Onglets de navigation de niveau supérieur pour organiser les sections principales. Voir Onglets.

Show tabs

tabstringrequired

Nom affiché de l’onglet. Longueur minimale : 1.

iconstring

L’icône à afficher.

Options:

Font Awesome nom d’icône, si vous avez la propriété icons.library paramètres définie sur fontawesome dans votre docs.json
Lucide nom d’icône, si vous avez la propriété icons.library paramètres définie sur lucide dans votre docs.json
Tabler nom d’icône, si vous avez la propriété icons.library paramètres définie sur tabler dans votre docs.json
URL vers une icône hébergée en externe
Chemin vers un fichier d’icône dans votre projet
Code SVG entouré d’accolades

Pour les icônes SVG personnalisées:

Convertissez votre SVG avec le convertisseur SVGR.
Collez votre code SVG dans le champ d’entrée SVG.
Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
Enveloppez le code SVG compatible JSX dans des accolades : icon={<svg ...> ... </svg>}.
Ajustez height et width selon vos besoins.

iconTypestring

Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

hiddenboolean

Indique s’il faut masquer cet onglet par défaut.

hrefstring (uri)required

URL ou chemin de destination de l’onglet.

anchorsarray of object

Liens d’ancrage qui apparaissent en évidence dans la barre latérale. Voir Ancres.

Show anchors

anchorstringrequired

Nom affiché de l’ancre. Longueur minimale : 1.

iconstring

L’icône à afficher.

Options:

Font Awesome nom d’icône, si vous avez la propriété icons.library paramètres définie sur fontawesome dans votre docs.json
Lucide nom d’icône, si vous avez la propriété icons.library paramètres définie sur lucide dans votre docs.json
Tabler nom d’icône, si vous avez la propriété icons.library paramètres définie sur tabler dans votre docs.json
URL vers une icône hébergée en externe
Chemin vers un fichier d’icône dans votre projet
Code SVG entouré d’accolades

Pour les icônes SVG personnalisées:

Convertissez votre SVG avec le convertisseur SVGR.
Collez votre code SVG dans le champ d’entrée SVG.
Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
Enveloppez le code SVG compatible JSX dans des accolades : icon={<svg ...> ... </svg>}.
Ajustez height et width selon vos besoins.

iconTypestring

Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

colorobject

Couleurs personnalisées pour l’icône de l’ancre.

Show color

lightstring

Couleur de l’ancre pour le mode clair. Doit être un code hexadécimal commençant par #.

darkstring

Couleur de l’ancre pour le mode sombre. Doit être un code hexadécimal commençant par #.

hiddenboolean

Indique s’il faut masquer cette ancre par défaut.

hrefstring (uri)required

URL ou chemin de destination de l’ancre.

dropdownsarray of object

Menus déroulants pour organiser le contenu connexe. Voir Menus déroulants.

Show dropdowns

dropdownstringrequired

Nom affiché du menu déroulant. Longueur minimale : 1.

iconstring

L’icône à afficher.

Options:

Font Awesome nom d’icône, si vous avez la propriété icons.library paramètres définie sur fontawesome dans votre docs.json
Lucide nom d’icône, si vous avez la propriété icons.library paramètres définie sur lucide dans votre docs.json
Tabler nom d’icône, si vous avez la propriété icons.library paramètres définie sur tabler dans votre docs.json
URL vers une icône hébergée en externe
Chemin vers un fichier d’icône dans votre projet
Code SVG entouré d’accolades

Pour les icônes SVG personnalisées:

Convertissez votre SVG avec le convertisseur SVGR.
Collez votre code SVG dans le champ d’entrée SVG.
Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
Enveloppez le code SVG compatible JSX dans des accolades : icon={<svg ...> ... </svg>}.
Ajustez height et width selon vos besoins.

iconTypestring

Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

hiddenboolean

Indique s’il faut masquer ce menu déroulant par défaut.

hrefstring (uri)required

URL ou chemin de destination du menu déroulant.

languagesarray of object

Configuration du sélecteur de langue pour les sites localisés. Voir Langues.

Show languages

language"ar" | "ca" | "cn" | "cs" | "de" | "en" | "es" | "fi" | "fr" | "fr-CA" | "he" | "hi" | "hu" | "id" | "it" | "ja" | "ja-JP" | "jp" | "ko" | "lv" | "nl" | "no" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sv" | "tr" | "uk" | "uz" | "vi" | "zh" | "zh-CN" | "zh-Hans" | "zh-Hant" | "zh-TW"required

Code de langue au format ISO 639-1.

defaultboolean

Indique s’il s’agit de la langue par défaut.

hiddenboolean

Indique s’il faut masquer cette option de langue par défaut.

hrefstring (uri)required

Un chemin ou un lien externe valide vers cette version linguistique de votre documentation.

versionsarray of object

Configuration du sélecteur de versions pour les sites multi-versions. Voir Versions.

Show versions

versionstringrequired

Nom affiché de la version. Longueur minimale : 1.

defaultboolean

Indique s’il s’agit de la version par défaut.

hiddenboolean

Indique s’il faut masquer cette version par défaut.

hrefstring (uri)required

URL ou chemin vers cette version de votre documentation.

productsarray of object

Sélecteur de produits pour les sites avec plusieurs produits. Voir Produits.

Show products

productstringrequired

Nom affiché du produit.

descriptionstring

Description du produit.

iconstring

L’icône à afficher.

Options:

Font Awesome nom d’icône, si vous avez la propriété icons.library paramètres définie sur fontawesome dans votre docs.json
Lucide nom d’icône, si vous avez la propriété icons.library paramètres définie sur lucide dans votre docs.json
Tabler nom d’icône, si vous avez la propriété icons.library paramètres définie sur tabler dans votre docs.json
URL vers une icône hébergée en externe
Chemin vers un fichier d’icône dans votre projet
Code SVG entouré d’accolades

Pour les icônes SVG personnalisées:

Convertissez votre SVG avec le convertisseur SVGR.
Collez votre code SVG dans le champ d’entrée SVG.
Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
Enveloppez le code SVG compatible JSX dans des accolades : icon={<svg ...> ... </svg>}.
Ajustez height et width selon vos besoins.

iconTypestring

Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

navigation.languagesarray 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.

Show navigation.languages

Code de langue au format ISO 639-1.

defaultboolean

Indique s’il s’agit de la langue par défaut.

bannerobject

Configuration de bannière spécifique à la langue. Accepte les mêmes options que le champ banner de niveau supérieur.

footerobject

Configuration de pied de page spécifique à la langue. Accepte les mêmes options que le champ footer de niveau supérieur.

navbarobject

Configuration de barre de navigation spécifique à la langue. Accepte les mêmes options que le champ navbar de niveau supérieur.

hiddenboolean

Indique s’il faut masquer cette option de langue par défaut.

navigation.versionsarray of object

Sélecteur de versions pour les sites avec plusieurs versions.

Show navigation.versions

defaultboolean

Définissez sur true pour faire de cette version la version par défaut. Si omis, la première version du tableau est la version par défaut.

tagstring

Libellé du badge affiché à côté de la version dans le sélecteur. Utilisez pour mettre en évidence des versions comme "Latest", "Recommended" ou "Beta".

navigation.tabsarray of object

Onglets de navigation de niveau supérieur.

navigation.anchorsarray of object

Ancres de la barre latérale.

navigation.dropdownsarray of object

Menus déroulants pour regrouper le contenu connexe.

navigation.productsarray of object

Sélecteur de produits pour les sites avec plusieurs produits.

navigation.groupsarray of object

Groupes pour organiser le contenu en sections.

navigation.pagesarray of string or object

Pages individuelles qui composent votre documentation.

navigation.directory"none" | "accordion" | "card"

Disposition de répertoire pour les pages racines dans les groupes de navigation. Lorsqu’il est défini, les groupes avec une page root affichent automatiquement une liste de leurs pages enfants sous le contenu de la page. Les valeurs s’héritent récursivement à travers l’arbre de navigation. Les descendants peuvent les remplacer. Voir Listes de répertoire.

Type : object

Liens et boutons affichés dans la barre de navigation supérieure.

navbar.linksarray of object

Liens à afficher dans la barre de navigation.

Show navbar.links

type"github" | "discord"

Type de lien facultatif. Omettez pour un lien textuel standard. Définissez sur github pour créer un lien vers un dépôt GitHub et afficher son nombre d’étoiles. Définissez sur discord pour créer un lien vers un serveur Discord et afficher le nombre d’utilisateurs en ligne.

labelstring

Texte du lien. Requis lorsque type n’est pas défini. Facultatif pour github et discord. Si omis, Mintlify génère le libellé à partir des données de l’API.

hrefstring (uri)required

Destination du lien. Doit être une URL externe valide. Pour github, doit être une URL de dépôt GitHub. Pour discord, doit être une URL d’invitation Discord.

iconstring

L’icône à afficher.

Options:

Font Awesome nom d’icône, si vous avez la propriété icons.library paramètres définie sur fontawesome dans votre docs.json
Lucide nom d’icône, si vous avez la propriété icons.library paramètres définie sur lucide dans votre docs.json
Tabler nom d’icône, si vous avez la propriété icons.library paramètres définie sur tabler dans votre docs.json
URL vers une icône hébergée en externe
Chemin vers un fichier d’icône dans votre projet
Code SVG entouré d’accolades

Pour les icônes SVG personnalisées:

Convertissez votre SVG avec le convertisseur SVGR.
Collez votre code SVG dans le champ d’entrée SVG.
Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
Enveloppez le code SVG compatible JSX dans des accolades : icon={<svg ...> ... </svg>}.
Ajustez height et width selon vos besoins.

iconTypestring

Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

navbar.primaryobject

Bouton d’appel à l’action principal dans la barre de navigation.

Show navbar.primary

type"button" | "github" | "discord"required

Style du bouton. Choisissez button pour un bouton standard, github pour un lien vers un dépôt GitHub avec nombre d’étoiles, ou discord pour une invitation Discord avec nombre d’utilisateurs en ligne.

labelstring

Texte du bouton. Requis lorsque type est button. Facultatif pour github et discord.

hrefstring (uri)required

Destination du bouton. Doit être une URL externe. Pour github, doit être une URL de dépôt GitHub. Pour discord, doit être une URL d’invitation Discord.

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.socialsobject

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.linksarray of object

Colonnes de liens affichées dans le pied de page. Maximum 4 colonnes.

Show footer.links

headerstring

Titre de l’en-tête de colonne. Longueur minimale : 1.

itemsarray of objectrequired

Liens à afficher dans la colonne.

Show items

labelstringrequired

Texte du lien. Longueur minimale : 1.

hrefstring (uri)required

URL de destination du lien.

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.contentstringrequired

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.dismissibleboolean

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.drilldownboolean

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.optionsarrayrequired

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
"download-pdf"—Télécharger la page actuelle au format PDF
"download-spec"—Télécharger les spécifications OpenAPI du déploiement (un seul fichier, ou compressées en zip s’il y en a plusieurs)
"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
"devin-desktop"—Ouvrir Devin Desktop avec la page actuelle comme contexte

Définissez des options personnalisées sous forme d’objets :

Show Option personnalisée

titlestringrequired

Titre affiché pour l’option personnalisée.

descriptionstringrequired

Texte descriptif pour l’option personnalisée.

iconstring

Icône pour l’option personnalisée. Prend en charge les noms de bibliothèque d’icônes, les URL, les chemins ou le code SVG.

hrefstring or objectrequired

Destination du lien. Peut être une chaîne URL ou un objet avec base et des paramètres query facultatifs.

Valeurs de substitution disponibles :

$page—Contenu de la page actuelle
$path—Chemin de la page actuelle
$mcp—URL du serveur MCP

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[].sourcestringrequired

Le chemin source à partir duquel rediriger. Exemple : /old-page

redirects[].destinationstringrequired

Le chemin de destination vers lequel rediriger. Exemple : /new-page

redirects[].permanentboolean

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.404object

Paramètres pour la page d’erreur 404 « Page non trouvée ».

Show errors.404

redirectboolean

Indique s’il faut rediriger automatiquement vers la page d’accueil lorsqu’une page n’est pas trouvée. Valeur par défaut : true.

titlestring

Titre personnalisé pour la page 404.

descriptionstring

Description personnalisée pour la page 404. Prend en charge le formatage MDX, y compris les liens, le texte en gras et en italique, et les composants personnalisés.

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.timestampboolean

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
}

Structure du site

Paramètres

`navigation` - required

`navbar`

`footer`

`banner`

`interaction`

`contextual`

`redirects`

`errors`

`variables`

`metadata`

On this page