Les champs requis ont un badge required. Tous les autres champs sont facultatifs.
Pour comprendre ce que fait chaque groupe de paramètres, consultez les pages thématiques :
Référence rapide
| Propriété | Type | Requis | Défaut |
|---|
theme | string | Oui | Aucun |
name | string | Oui | Aucun |
colors.primary | string (hex) | Oui | Aucun |
navigation | object | Oui | Aucun |
description | string | Non | Aucun |
logo | string ou object | Non | Aucun |
favicon | string ou object | Non | Aucun |
appearance.default | "system" | "light" | "dark" | Non | "system" |
appearance.strict | boolean | Non | false |
fonts.family | string | Non | Défaut du thème |
icons.library | "fontawesome" | "lucide" | "tabler" | Non | "fontawesome" |
background.decoration | "gradient" | "grid" | "windows" | Non | Aucun |
styling.eyebrows | "section" | "breadcrumbs" | Non | "section" |
styling.latex | boolean | Non | Auto-détecté |
styling.codeblocks | "system" | "dark" | string | object | Non | "system" |
thumbnails.appearance | "light" | "dark" | Non | Défaut du site |
navbar.links | array | Non | Aucun |
navbar.primary | object | Non | Aucun |
footer.socials | object | Non | Aucun |
footer.links | array | Non | Aucun |
banner.content | string | Non | Aucun |
banner.dismissible | boolean | Non | false |
interaction.drilldown | boolean | Non | Défaut du thème |
contextual.options | array | Non | Aucun |
contextual.display | "header" | "toc" | Non | "header" |
redirects | array | Non | Aucun |
variables | object | Non | Aucun |
metadata.timestamp | boolean | Non | false |
errors.404.redirect | boolean | Non | true |
api.openapi | string ou array ou object | Non | Aucun |
api.asyncapi | string ou array ou object | Non | Aucun |
api.playground.display | "interactive" | "simple" | "none" | "auth" | Non | "interactive" |
api.playground.proxy | boolean | Non | true |
api.params.expanded | "all" | "closed" | Non | "closed" |
api.url | "full" | Non | Aucun |
api.examples.languages | array of string | Non | Aucun |
api.examples.defaults | "required" | "all" | Non | "all" |
api.examples.prefill | boolean | Non | false |
api.examples.autogenerate | boolean | Non | true |
api.spec.download | boolean | Non | false |
seo.indexing | "navigable" | "all" | Non | "navigable" |
seo.metatags | object | Non | Aucun |
search.prompt | string | Non | Aucun |
integrations.* | object | Non | Aucun |
Référence complète des propriétés
theme - required
Le thème de mise en page de votre site.
Type : string
Options : mint, maple, palm, willow, linden, almond, aspen, sequoia, luma
Voir Thèmes pour les aperçus.
name - required
Le nom de votre projet, organisation ou produit.
Type : string
colors - required
Les couleurs utilisées dans votre documentation.
Type : object
colors.primary
required
La couleur principale. Généralement utilisée pour la mise en évidence en mode clair.
Type : string — code hexadécimal correspondant à ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
colors.light
La couleur utilisée pour la mise en évidence en mode sombre.
Type : string — code hexadécimal correspondant à ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
colors.dark
La couleur utilisée pour les boutons et les états de survol dans les deux modes.
Type : string — code hexadécimal correspondant à ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
navigation - required
La structure de navigation de votre contenu.
Type : object
Voir Navigation pour la documentation complète.
navigation.global
Éléments de navigation globaux qui apparaissent sur toutes les pages et locales.
Type : object
navigation.global.tabs
Onglets de navigation de niveau supérieur.
Type : array of object — chacun avec : tab (string, requis), icon (string), iconType (string), hidden (boolean), href (string uri, requis)
navigation.global.anchors
Liens d’ancrage de la barre latérale.
Type : array of object — chacun avec : anchor (string, requis), icon (string), iconType (string), color.light (string hex), color.dark (string hex), hidden (boolean), href (string uri, requis)
navigation.global.dropdowns
Menus déroulants.
Type : array of object — chacun avec : dropdown (string, requis), icon (string), iconType (string), hidden (boolean), href (string uri, requis)
navigation.global.languages
Sélecteur de langue dans la navigation globale.
Type : array of object — chacun avec : language (string, requis), default (boolean), hidden (boolean), href (string uri, requis)
Codes de langue pris en charge : ar, ca, cn, cs, de, en, es, fr, he, hi, hu, id, it, ja, jp, ko, lv, nl, no, pl, pt, pt-BR, ro, ru, sv, tr, ua, uz, vi, zh, zh-Hans, zh-Hant
navigation.global.versions
Sélecteur de versions dans la navigation globale.
Type : array of object — chacun avec : version (string, requis, longueur min 1), default (boolean), hidden (boolean), href (string uri, requis)
navigation.global.products
Sélecteur de produits dans la navigation globale.
Type : array of object — chacun avec : product (string, requis), description (string), icon (string), iconType (string)
navigation.languages
Sélecteur de langue pour les sites multilingues. Chaque entrée peut inclure des remplacements banner, footer et navbar spécifiques à la langue.
Type : array of object — chacun avec : language (string, requis), default (boolean), hidden (boolean), banner (object), footer (object), navbar (object)
Codes de langue pris en charge : ar, ca, cn, cs, de, en, es, fr, he, hi, id, it, ja, jp, ko, lv, nl, no, pl, pt, pt-BR, ro, ru, sv, tr, uk, uz, vi, zh, zh-Hans, zh-Hant
navigation.versions
Sélecteur de versions pour les sites multi-versions.
Type : array of object — chacun avec : default (boolean), tag (string)
navigation.tabs
Onglets de navigation de niveau supérieur.
Type : array of object — voir navigation.global.tabs pour la structure.
navigation.anchors
Liens d’ancrage de la barre latérale.
Type : array of object — voir navigation.global.anchors pour la structure.
navigation.dropdowns
Menus déroulants.
Type : array of object — voir navigation.global.dropdowns pour la structure.
navigation.products
Sélecteur de produits.
Type : array of object — voir navigation.global.products pour la structure.
navigation.groups
Groupes pour organiser le contenu en sections étiquetées.
Type : array of object
navigation.pages
Pages individuelles de votre documentation.
Type : array of string ou object
description
Description du site pour le SEO et l’indexation par l’IA.
Type : string
logo
Logo du site. Fournissez une chaîne de chemin ou des objets light et dark distincts.
Type : string ou object
logo.light
required (lors de l’utilisation de la forme objet)
Chemin vers le logo pour le mode clair. Exemple : /logo/light.svg.
Type : string
logo.dark
required (lors de l’utilisation de la forme objet)
Chemin vers le logo pour le mode sombre. Exemple : /logo/dark.svg.
Type : string
logo.href
URL vers laquelle rediriger lors d’un clic sur le logo.
Type : string (uri)
favicon
Favicon du site. Redimensionné automatiquement. Fournissez une chaîne de chemin ou des objets light et dark distincts.
Type : string ou object
favicon.light
required (lors de l’utilisation de la forme objet)
Chemin vers le favicon pour le mode clair. Exemple : /favicon.png.
Type : string
favicon.dark
required (lors de l’utilisation de la forme objet)
Chemin vers le favicon pour le mode sombre. Exemple : /favicon-dark.png.
Type : string
appearance
Paramètres du mode clair/sombre.
Type : object
appearance.default
Mode de couleur par défaut.
Type : "system" | "light" | "dark"
Défaut : "system"
appearance.strict
Lorsque true, masque l’interrupteur du mode clair/sombre.
Type : boolean
Défaut : false
fonts
Polices personnalisées. Prend en charge Google Fonts et les polices auto-hébergées.
Type : object
fonts.family
required (lors de l’utilisation de fonts)
Nom de la famille de polices. Les noms de familles Google Fonts se chargent automatiquement.
Type : string
fonts.weight
Graisse de la police. Les polices variables prennent en charge les valeurs fractionnaires comme 550.
Type : number
fonts.source
URL vers une police hébergée ou chemin vers un fichier de police local. Non nécessaire pour les Google Fonts.
Type : string (uri)
Format du fichier de police. Requis lors de l’utilisation de fonts.source.
Type : "woff" | "woff2"
fonts.heading
Remplace les paramètres de police pour les titres. Accepte les mêmes champs family, weight, source et format.
Type : object
fonts.body
Remplace les paramètres de police pour le corps du texte. Accepte les mêmes champs family, weight, source et format.
Type : object
icons
Paramètres de la bibliothèque d’icônes.
Type : object
icons.library
required
Bibliothèque d’icônes à utiliser dans toute votre documentation. Tous les noms d’icônes de vos docs doivent provenir de la bibliothèque sélectionnée.
Type : "fontawesome" | "lucide" | "tabler"
Défaut : "fontawesome"
background
Paramètres d’image d’arrière-plan, de décoration et de couleur.
Type : object
background.decoration
Motif d’arrière-plan décoratif.
Type : "gradient" | "grid" | "windows"
background.color
Couleurs d’arrière-plan personnalisées.
Type : object
background.color.light
Couleur d’arrière-plan pour le mode clair.
Type : string — code hexadécimal correspondant à ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
background.color.dark
Couleur d’arrière-plan pour le mode sombre.
Type : string — code hexadécimal correspondant à ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
background.image
Image d’arrière-plan. Fournissez une chaîne de chemin ou des objets light et dark distincts.
Type : string ou object
background.image.light
required (lors de l’utilisation de la forme objet)
Chemin de l’image d’arrière-plan pour le mode clair.
Type : string
background.image.dark
required (lors de l’utilisation de la forme objet)
Chemin de l’image d’arrière-plan pour le mode sombre.
Type : string
styling
Contrôles de style visuel.
Type : object
styling.eyebrows
Style de l’eyebrow de la page affiché en haut de la page.
Type : "section" | "breadcrumbs"
Défaut : "section"
styling.latex
Indique s’il faut charger les feuilles de style LaTeX. Par défaut, Mintlify détecte automatiquement l’utilisation de LaTeX.
Type : boolean
styling.codeblocks
Configuration du thème des blocs de code.
Type : "system" | "dark" | string (nom de thème Shiki) | object
Défaut : "system"
Lorsqu’il s’agit d’un objet :
styling.codeblocks.theme
Un nom de thème Shiki unique pour les deux modes, ou un objet avec les noms de thèmes Shiki light et dark.
Type : string ou object
styling.codeblocks.languages
Configuration personnalisée des langages.
Type : object
styling.codeblocks.languages.custom
Chemins vers des fichiers JSON décrivant des langages Shiki personnalisés au format de grammaire TextMate.
Type : array of string
thumbnails
Personnalisation des vignettes pour les réseaux sociaux.
Type : object
thumbnails.appearance
Thème visuel pour les vignettes.
Type : "light" | "dark"
Défaut : Jeu de couleurs du site
thumbnails.background
Image d’arrière-plan pour les vignettes. Peut être un chemin relatif ou une URL absolue.
Type : string
thumbnails.fonts
Configuration des polices pour les vignettes.
Type : object
thumbnails.fonts.family
required (lors de l’utilisation de thumbnails.fonts)
Nom de la famille de polices. Prend uniquement en charge Google Fonts.
Type : string
navbar
Configuration de la barre de navigation supérieure.
Type : object
navbar.links
Liens affichés dans la barre de navigation.
Type : array of object — chacun avec :
| Champ | Type | Requis | Description |
|---|
type | "github" | "discord" | Non | Type de lien. Omettre pour un lien standard. |
label | string | Conditionnel | Requis lorsque type est omis. |
href | string (uri) | Oui | Destination du lien. |
icon | string | Non | Nom d’icône, URL, chemin ou SVG. |
iconType | string | Non | Style d’icône Font Awesome uniquement. |
navbar.primary
Bouton d’appel à l’action principal dans la barre de navigation.
Type : object
| Champ | Type | Requis | Description |
|---|
type | "button" | "github" | "discord" | Oui | Style du bouton. |
label | string | Conditionnel | Requis lorsque type est "button". |
href | string (uri) | Oui | Destination du bouton. |
Contenu du pied de page et liens sociaux.
Type : object
Profils de réseaux sociaux. Chaque clé est un nom de plateforme, chaque valeur est l’URL de votre profil.
Type : object
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
Colonnes de liens dans le pied de page.
Type : array of object — chacun avec : header (string), items (array of { label: string, href: string }, requis)
banner
Bannière globale affichée en haut de chaque page.
Type : object
banner.content
required (lors de l’utilisation de banner)
Texte de la bannière. Prend en charge le formatage MDX de base, y compris les liens, le gras et l’italique. Les composants personnalisés ne sont pas pris en charge.
Type : string
banner.dismissible
Indique s’il faut afficher un bouton de fermeture.
Type : boolean
Défaut : false
interaction
Paramètres d’interaction de navigation.
Type : object
interaction.drilldown
Contrôle la navigation automatique lorsqu’un utilisateur clique sur un groupe de navigation. Définissez sur true pour naviguer vers la première page lorsqu’un utilisateur clique sur un groupe, false pour uniquement développer/réduire le groupe sans naviguer.
Type : boolean
Défaut : Défaut du thème
contextual
Menu contextuel pour les actions de page et les intégrations d’outils IA.
Type : object
contextual.options
required
Actions disponibles dans le menu contextuel. Le premier élément est l’action par défaut.
Type : array of "assistant" | "copy" | "view" | "chatgpt" | "claude" | "perplexity" | "grok" | "aistudio" | "mcp" | "add-mcp" | "cursor" | "vscode" | object
Champs de l’objet option personnalisée :
| Champ | Type | Requis | Description |
|---|
title | string | Oui | Titre affiché. |
description | string | Oui | Texte descriptif. |
icon | string | Non | Nom d’icône, URL, chemin ou SVG. |
href | string ou object | Oui | Destination du lien. Prend en charge les substitutions $page, $path, $mcp. |
contextual.display
Où afficher le menu contextuel.
Type : "header" | "toc"
Défaut : "header"
Le menu contextuel est uniquement disponible sur les déploiements de prévisualisation et de production.
redirects
Redirections pour les pages déplacées, renommées ou supprimées.
Type : array of object — chacun avec :
| Champ | Type | Requis | Description |
|---|
source | string | Oui | Chemin source. Exemple : /old-page |
destination | string | Oui | Chemin de destination. Exemple : /new-page |
permanent | boolean | Non | true pour 308, false pour 307. Défaut : true. |
variables
Variables de contenu globales remplacées au moment de la compilation en utilisant la syntaxe {{variableName}}.
Type : object — paires clé-valeur où les clés sont des noms de variables (alphanumériques, tirets, points) et les valeurs sont des chaînes de remplacement.
Paramètres globaux de métadonnées de page.
Type : object
Affiche une date de dernière modification sur toutes les pages.
Type : boolean
Défaut : false
errors
Paramètres de la page d’erreur.
Type : object
errors.404
Paramètres pour la page d’erreur 404 « Page non trouvée ».
Type : object
errors.404.redirect
Indique s’il faut rediriger automatiquement vers la page d’accueil lorsqu’une page n’est pas trouvée.
Type : boolean
Défaut : true
errors.404.title
Titre personnalisé pour la page 404.
Type : string
errors.404.description
Description personnalisée pour la page 404. Prend en charge le formatage MDX, y compris les liens, le gras, l’italique et les composants personnalisés.
Type : string
api
Paramètres de documentation et de playground d’API.
Type : object
api.openapi
Fichiers de spécification OpenAPI.
Type : string | array of string | object avec source (string) et directory (string)
api.asyncapi
Fichiers de spécification AsyncAPI.
Type : string | array of string | object avec source (string) et directory (string)
api.playground
Paramètres du playground interactif.
Type : object
api.playground.display
Mode d’affichage du playground.
Type : "interactive" | "simple" | "none" | "auth"
Défaut : "interactive"
api.playground.proxy
Indique s’il faut router les requêtes d’API via un proxy.
Type : boolean
Défaut : true
api.params
Paramètres d’affichage des paramètres d’API.
Type : object
api.params.expanded
Indique s’il faut développer tous les paramètres par défaut.
Type : "all" | "closed"
Défaut : "closed"
api.url
Mode d’affichage de l’URL de base.
Type : "full"
Défaut : Affiché uniquement lorsqu’il existe plusieurs URL de base.
api.examples
Paramètres des exemples de code.
Type : object
api.examples.languages
Langages pour les extraits de code générés automatiquement. Voir langages pris en charge.
Type : array of string
api.examples.defaults
Indique s’il faut inclure les paramètres facultatifs dans les exemples.
Type : "required" | "all"
Défaut : "all"
api.examples.prefill
Indique s’il faut préremplir les champs du playground avec les valeurs d’exemple de la spec.
Type : boolean
Défaut : false
api.examples.autogenerate
Indique s’il faut générer des exemples de code à partir des spécifications d’API.
Type : boolean
Défaut : true
api.spec
Paramètres d’affichage de la spécification OpenAPI.
Type : object
api.spec.download
Indique s’il faut afficher un bouton de téléchargement pour la spécification OpenAPI sur les pages de référence d’API.
Type : boolean
Défaut : false
api.mdx
Paramètres pour les pages d’API construites à partir de fichiers MDX.
Type : object
api.mdx.auth
Configuration d’authentification pour les requêtes d’API basées sur MDX.
Type : object
api.mdx.auth.method
Méthode d’authentification.
Type : "bearer" | "basic" | "key" | "cobo"
api.mdx.auth.name
Nom du paramètre d’authentification.
Type : string
api.mdx.server
URL de base ajoutée en préfixe aux chemins relatifs dans le frontmatter api au niveau de la page. Non utilisée lorsque le frontmatter contient une URL complète.
Type : string ou array
seo
Paramètres d’optimisation pour les moteurs de recherche.
Type : object
seo.indexing
Quelles pages les moteurs de recherche doivent indexer.
Type : "navigable" | "all"
Défaut : "navigable"
Balises meta personnalisées ajoutées à chaque page. Paires clé-valeur.
Type : object
search
Paramètres de la barre de recherche.
Type : object
search.prompt
Texte d’espace réservé dans la barre de recherche.
Type : string
integrations
Intégrations tierces.
Type : object
| Propriété | Type | Champ requis | Description |
|---|
integrations.adobe.launchUrl | string (uri) | Oui | URL de lancement Adobe Analytics. |
integrations.amplitude.apiKey | string | Oui | Clé d’API Amplitude. |
integrations.clarity.projectId | string | Oui | Identifiant de projet Microsoft Clarity. |
integrations.clearbit.publicApiKey | string | Oui | Clé d’API publique Clearbit. |
integrations.fathom.siteId | string | Oui | Identifiant de site Fathom. |
integrations.frontchat.snippetId | string (min 6) | Oui | Identifiant de snippet Front chat. |
integrations.ga4.measurementId | string (doit commencer par G) | Oui | Identifiant de mesure Google Analytics 4. |
integrations.gtm.tagId | string (doit commencer par G) | Oui | Identifiant de conteneur Google Tag Manager. |
integrations.heap.appId | string | Oui | Identifiant d’application Heap. |
integrations.hightouch.writeKey | string | Oui | Clé d’écriture Hightouch. |
integrations.hightouch.apiHost | string | Non | Hôte d’API Hightouch. |
integrations.hotjar.hjid | string | Oui | Identifiant de site Hotjar. |
integrations.hotjar.hjsv | string | Oui | Version du script Hotjar. |
integrations.intercom.appId | string (min 6) | Oui | Identifiant d’application Intercom. |
integrations.logrocket.appId | string | Oui | Identifiant d’application LogRocket. |
integrations.mixpanel.projectToken | string | Oui | Token de projet Mixpanel. |
integrations.pirsch.id | string | Oui | Identifiant de site Pirsch. |
integrations.plausible.domain | string | Oui | Domaine Plausible. |
integrations.plausible.server | string | Non | Serveur Plausible (auto-hébergé uniquement). |
integrations.posthog.apiKey | string (doit commencer par phc_) | Oui | Clé d’API PostHog. |
integrations.posthog.apiHost | string (uri) | Non | Hôte d’API PostHog (auto-hébergé uniquement). |
integrations.posthog.sessionRecording | boolean | Non | Activer l’enregistrement de session. Défaut : false. |
integrations.segment.key | string | Oui | Clé d’écriture Segment. |
integrations.telemetry.enabled | boolean | Non | Activer la télémétrie Mintlify. Lorsque false, les fonctionnalités de feedback sont également désactivées. |
integrations.cookies.key | string | Non | Nom de la clé du cookie. |
integrations.cookies.value | string | Non | Valeur du cookie. |
