Paramètres globaux

Configurez les paramètres du site à l’échelle globale avec le fichier docs.json

Le fichier docs.json vous permet de transformer une collection de fichiers Markdown en un site de documentation navigable et personnalisable. Ce fichier de configuration obligatoire contrôle le style, la navigation, les intégrations, et bien plus encore. Considérez-le comme le plan de votre documentation.

Les paramètres de docs.json s’appliquent globalement à toutes les pages.

​

Configuration de votre docs.json

Pour commencer, vous n’avez besoin d’indiquer que theme, name, colors.primary et navigation. Les autres champs sont facultatifs et vous pourrez les ajouter à mesure que vos besoins en documentation évoluent.

Pour une expérience d’édition optimale, ajoutez la référence de schéma en haut de votre fichier docs.json. Cela active l’autocomplétion, la validation et des info-bulles utiles dans la plupart des éditeurs de code :

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Vos docs",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": {
    // Votre structure de navigation
  }
  // Le reste de votre configuration
}

​

Référence

Cette section contient la référence complète du fichier docs.json.

​

Personnalisation

theme · requis

Le thème de mise en page de votre site.

L’un des suivants : mint, maple, palm, willow, linden, almond, aspen.

Voir Thèmes pour plus d’informations.

name · string · requis

Le nom de votre projet, de votre organisation ou de votre produit.

colors · object · requis

Les couleurs utilisées dans votre documentation. Leur application varie selon le thème. Si vous ne fournissez qu’une couleur principale, elle sera utilisée pour tous les éléments colorés.

Afficher Couleurs

primary · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$ · requis

La couleur principale de votre documentation. Généralement utilisée pour la mise en avant en mode clair, avec quelques variations selon le thème.

Doit être un code hexadécimal commençant par #.

light · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

La couleur utilisée pour la mise en avant en mode sombre.

Doit être un code hexadécimal commençant par #.

dark · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

La couleur utilisée pour les boutons et les états au survol en modes clair et sombre, avec quelques variations selon le thème.

Doit être un code hexadécimal commençant par #.

description · string

Description de votre site pour le référencement (SEO) et l’indexation par l’IA.

logo · string or object

Votre logo pour les modes clair et sombre.

Afficher Logo

light · string · requis

Chemin vers le fichier de votre logo pour le mode clair. Incluez l’extension du fichier. Exemple : /logo.png

dark · string · requis

Chemin vers le fichier de votre logo pour le mode sombre. Incluez l’extension du fichier. Exemple : /logo-dark.png

href · string (uri)

L’URL vers laquelle rediriger lorsqu’on clique sur le logo. Si elle n’est pas fournie, le logo renverra vers votre page d’accueil. Exemple : https://mintlify.com

favicon · string or object

Chemin vers votre fichier favicon, incluant l’extension. Redimensionné automatiquement aux tailles de favicon appropriées. Peut être un fichier unique ou des fichiers distincts pour les modes clair et sombre. Exemple : /favicon.png

Afficher Favicon

light · string · requis

Chemin vers votre fichier favicon pour le mode clair. Incluez l’extension du fichier. Exemple : /favicon.png

dark · string · requis

Chemin vers votre fichier favicon pour le mode sombre. Incluez l’extension du fichier. Exemple : /favicon-dark.png

thumbnails · object

Personnalisation des vignettes pour les réseaux sociaux et les aperçus de page.

Afficher Vignettes

appearance · "light" | "dark"

Le thème visuel de vos vignettes. S’il n’est pas spécifié, les vignettes utilisent la palette de couleurs de votre site définie par le champ colors.

background · string

Image d’arrière-plan pour vos vignettes. Peut être un chemin relatif ou une URL absolue.

styling · object

Configuration du style visuel.

Afficher Styling

eyebrows · "section" | "breadcrumbs"

Style de l’eyebrow de page. Choisissez section pour afficher le nom de la section ou breadcrumbs pour afficher le chemin de navigation complet. Par défaut : section.

codeblocks · "system" | "dark" | object

Configuration du thème des blocs de code. Par défaut : "system".

Options simples :

• "system" : faire correspondre le mode actuel du site (clair ou sombre)
• "dark" : utiliser toujours le mode sombre

Configuration de thème personnalisée : Utilisez un objet pour spécifier des thèmes Shiki. Choisissez un seul thème pour les deux modes ou des thèmes distincts pour les modes clair et sombre.

Afficher codeblocks

theme · string

Un nom de thème Shiki unique à utiliser pour les modes clair et sombre.

"styling": {
  "codeblocks": {
    "theme": "dracula"
  }
}

themes · object

Thèmes distincts pour les modes clair et sombre.

Afficher themes

light · string · requis

Un nom de thème Shiki pour le mode clair.

dark · string · requis

Un nom de thème Shiki pour le mode sombre.

"styling": {
  "codeblocks": {
    "themes": {
      "light": "github-light",
      "dark": "github-dark"
    }
  }
}

icons · object

Paramètres de la bibliothèque d’icônes.

Afficher Icons

library · "fontawesome" | "lucide" · requis

Bibliothèque d’icônes à utiliser dans l’ensemble de votre documentation. Par défaut : fontawesome.

Vous pouvez spécifier une URL vers une icône hébergée en externe, un chemin vers un fichier d’icône dans votre projet, ou du code SVG compatible JSX pour n’importe quelle icône individuelle, quel que soit le paramètre de bibliothèque.

fonts · object

Configuration des polices pour votre documentation. La police par défaut est Inter.

Afficher Fonts

family · string · requis

Famille de polices, par exemple « Open Sans », « Playfair Display ».

weight · number

Graisse de police, par exemple 400 ou 700. Les polices variables prennent en charge des graisses précises comme 550.

source · string (uri)

URL de la source de votre police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. Google Fonts est chargé automatiquement lorsque vous spécifiez un nom de family Google Fonts, donc aucune URL source n’est nécessaire.

format · "woff" | "woff2"

Format du fichier de police.

heading · object

Remplace les paramètres de police spécifiquement pour les titres.

Afficher Heading

family · string · requis

Famille de polices, par exemple « Open Sans », « Playfair Display ».

weight · number

Graisse de police, par exemple 400 ou 700. Les polices variables prennent en charge des graisses précises comme 550.

source · string (uri)

URL de la source de votre police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. Google Fonts est chargé automatiquement lorsque vous spécifiez un nom de family Google Fonts, donc aucune URL source n’est nécessaire.

format · "woff" | "woff2"

Format du fichier de police.

body · object

Remplace les paramètres de police spécifiquement pour le corps de texte.

Afficher Body

family · string · requis

Famille de polices, par exemple « Open Sans », « Playfair Display ».

weight · number

Graisse de police, par exemple 400 ou 700. Les polices variables prennent en charge des graisses précises comme 550.

source · string (uri)

URL de la source de votre police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. Google Fonts est chargé automatiquement lorsque vous spécifiez un nom de family Google Fonts, donc aucune URL source n’est nécessaire.

format · "woff" | "woff2"

Format du fichier de police.

appearance · object

Paramètres de l’interrupteur de mode clair/sombre.

Afficher Appearance

default · "system" | "light" | "dark"

Mode de thème par défaut. Choisissez system pour s’aligner sur les paramètres du système d’exploitation de l’utilisateur, ou light/dark pour imposer un mode spécifique. Par défaut : system.

strict · boolean

Indique s’il faut masquer l’interrupteur clair/sombre. Par défaut : true.

background · object

Paramètres de couleur et de décoration d’arrière-plan.

Afficher Background

image · string or object

Image d’arrière-plan pour votre site. Peut être un fichier unique ou des fichiers distincts pour les modes clair et sombre.

Afficher Image

light · string · requis

Chemin vers votre image d’arrière-plan pour le mode clair. Incluez l’extension du fichier. Exemple : /background.png.

dark · string · requis

Chemin vers votre image d’arrière-plan pour le mode sombre. Incluez l’extension du fichier. Exemple : /background-dark.png.

decoration · "gradient" | "grid" | "windows"

Décoration d’arrière-plan pour votre thème.

color · object

Couleurs d’arrière-plan personnalisées pour les modes clair et sombre.

Afficher Color

light · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Couleur d’arrière-plan pour le mode clair.

Doit être un code hexadécimal commençant par #.

dark · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Couleur d’arrière-plan pour le mode sombre.

Doit être un code hexadécimal commençant par #.

​

Structure

navbar · object

Éléments de la barre de navigation.

Afficher Navbar

links · array of object

Liens à afficher dans la barre de navigation.

Afficher Links

label · string · requis

Texte du lien.

href · string (uri) · requis

URL ou chemin de destination du lien.

icon · string

L’icône à afficher.

Options :

• Nom d’icône Font Awesome
• Nom d’icône Lucide
• Code SVG compatible JSX entre accolades
• URL d’une icône hébergée en externe
• Chemin vers un fichier d’icône dans votre projet

Pour des icônes SVG personnalisées :

1. Convertissez votre SVG avec le convertisseur SVGR.
2. Collez votre code SVG dans le champ de saisie SVG.
3. Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
4. Mettez le code SVG compatible JSX entre accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width au besoin.

iconType · string

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

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

primary · object

Bouton principal de la barre de navigation.

Afficher Primary

type · "button" | "github" · requis

Style du bouton. Choisissez button pour un bouton standard avec libellé, ou github pour un lien vers un dépôt GitHub avec icône.

label · string · requis

Texte du bouton. S’applique uniquement lorsque type vaut button.

href · string (uri) · requis

Destination du bouton. Doit être un chemin valide ou une URL externe. Si type est github, il doit s’agir de l’URL d’un dépôt GitHub.

navigation · object · requis

La structure de navigation de votre contenu.

Afficher Navigation

global · object

Éléments de navigation globaux qui apparaissent sur l’ensemble des pages et sections.

Afficher Global

langues · array of object

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

Afficher Langues

language · "en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "ja" | "jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "id" | "ar" | "tr" · requis

Code de langue au format ISO 639-1

default · boolean

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

hidden · boolean

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

href · string (uri) · requis

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

versions · array of object

Configuration du sélecteur de versions pour les sites multi‑versions.

Afficher Versions

version · string · requis

Nom affiché de la version.

Longueur minimale : 1

default · boolean

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

hidden · boolean

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

href · string (uri) · requis

URL ou chemin vers cette version de votre documentation.

onglets · array of object

Onglets de navigation de premier niveau pour organiser les sections principales.

Afficher Tabs

tab · string · requis

Nom affiché de l’onglet.

Longueur minimale : 1

icon · string

L’icône à afficher.

Options :

• Nom d’icône Font Awesome
• Nom d’icône Lucide
• Code SVG compatible JSX entre accolades
• URL d’une icône hébergée en externe
• Chemin vers un fichier d’icône dans votre projet

Pour des icônes SVG personnalisées :

1. Convertissez votre SVG avec le convertisseur SVGR.
2. Collez votre code SVG dans le champ de saisie SVG.
3. Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
4. Mettez le code SVG compatible JSX entre accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width au besoin.

iconType · string

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

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

hidden · boolean

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

href · string (uri) · requis

URL ou chemin de destination de l’onglet.

ancres · array of object

Liens d’ancrage qui apparaissent en évidence dans la navigation de la barre latérale.

Afficher Ancres

anchor · string · requis

Nom affiché de l’ancre.

Longueur minimale : 1

icon · string

L’icône à afficher.

Options :

• Nom d’icône Font Awesome
• Nom d’icône Lucide
• Code SVG compatible JSX entre accolades
• URL d’une icône hébergée en externe
• Chemin vers un fichier d’icône dans votre projet

Pour des icônes SVG personnalisées :

1. Convertissez votre SVG avec le convertisseur SVGR.
2. Collez votre code SVG dans le champ de saisie SVG.
3. Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
4. Mettez le code SVG compatible JSX entre accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width au besoin.

iconType · string

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

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

color · object

Couleurs personnalisées de l’ancre.

Afficher Couleur

light · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Couleur de l’ancre en mode clair.

Doit être un code hexadécimal commençant par #.

dark · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Couleur de l’ancre en mode sombre.

Doit être un code hexadécimal commençant par #.

hidden · boolean

Indique si cette ancre est masquée par défaut.

href · string (uri) · requis

URL ou chemin de destination de l’ancre.

menus déroulants · array of object

Menus déroulants pour organiser du contenu connexe.

Afficher Dropdowns

dropdown · string · requis

Nom affiché du menu déroulant.

Longueur minimale : 1

icon · string

L’icône à afficher.

Options :

• Nom d’icône Font Awesome
• Nom d’icône Lucide
• Code SVG compatible JSX entre accolades
• URL d’une icône hébergée en externe
• Chemin vers un fichier d’icône dans votre projet

Pour des icônes SVG personnalisées :

1. Convertissez votre SVG avec le convertisseur SVGR.
2. Collez votre code SVG dans le champ de saisie SVG.
3. Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
4. Mettez le code SVG compatible JSX entre accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width au besoin.

iconType · string

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

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

hidden · boolean

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

href · string (uri) · requis

URL ou chemin de destination du menu déroulant.

langues · array of object

Sélecteur de langue pour les sites multilingues.

versions · array of object

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

onglets · array of object

Navigation de niveau supérieur onglets.

ancres · array of object

Barre latérale : ancres.

menus déroulants · array of object

Menus déroulants pour regrouper du contenu associé.

groupes · array of object

Groupes pour organiser le contenu en sections.

pages · array of string or object

Pages individuelles qui constituent votre documentation.

interaction · object

Paramètres d’interaction utilisateur pour les éléments de navigation.

Afficher Interaction

drilldown · boolean

Contrôle le comportement de navigation automatique lors de la sélection de groupes de navigation. Définissez sur true pour forcer la navigation vers la première page lorsqu’un groupe de navigation est développé. Définissez sur false pour empêcher la navigation et uniquement développer ou réduire le groupe. Laissez non défini pour utiliser le comportement par défaut du thème.

footer · object

Contenu du pied de page et liens vers les réseaux sociaux.

Afficher 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. Par exemple :

{
  "x": "https://x.com/mintlify"
}

Noms de propriétés valides : x, website, facebook, youtube, discord, slack, github, linkedin, instagram, hacker-news, medium, telegram, twitter, x-twitter, earth-americas, bluesky, threads, reddit, podcast

links · array of object

Liens à afficher dans le pied de page.

Afficher Links

header · string

Titre de la colonne.

Longueur minimale : 1

items · array of object · requis

Liens à afficher dans la colonne.

Afficher Items

label · string · requis

Texte du lien.

Longueur minimale : 1

href · string (uri) · requis

URL de destination du lien.

banner · object

Bannière globale du site affichée en haut des pages.

Afficher Banner

content · string

Contenu de la bannière. Prend en charge le texte brut et la mise en forme Markdown. Par exemple :

{
  "content": "🚀 Bannière en ligne ! [En savoir plus](mintlify.com)"
}

dismissible · boolean

Indique si les utilisateurs peuvent fermer la bannière. Par défaut : false.

redirects · array of object

Redirections pour les pages déplacées, renommées ou supprimées.

Afficher Redirects

source · string · requis

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

destination · string · requis

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

permanent · boolean

Indique s’il faut utiliser une redirection permanente (301). Par défaut : true.

contextual · object

Menu contextuel pour le contenu optimisé par l’IA et les intégrations.

Afficher Contextual

options · array of "copy" | "view" | "chatgpt" | "claude" | "perplexity" | "mcp" | "cursor" | "vscode" · requis

Actions disponibles dans le menu contextuel. La première option apparaît par défaut.

• copy: Copier la page actuelle en Markdown dans le presse-papiers.
• view: Afficher la page actuelle en Markdown dans un nouvel onglet.
• chatgpt: Envoyer le contenu de la page actuelle à ChatGPT.
• claude: Envoyer le contenu de la page actuelle à Claude.
• perplexity: Envoyer le contenu de la page actuelle à Perplexity.
• mcp: Copier l’URL de votre serveur MCP dans le presse-papiers.
• cursor: Installer votre serveur MCP hébergé dans Cursor.
• vscode: Installer votre serveur MCP hébergé dans VSCode.

Le menu contextuel est disponible uniquement sur les déploiements de prévisualisation et de production.

​

Configurations d’API

api · object

Paramètres de la documentation API et du terrain de jeu interactif.

Afficher Api

openapi · string or array or object

Fichiers de spécification OpenAPI pour générer la documentation API. Peut être une seule URL/un seul chemin ou un tableau d’URL/de chemins.

Afficher Openapi

source · string

URL ou chemin vers votre fichier de spécification OpenAPI.

Longueur minimale : 1

directory · string

Répertoire dans lequel rechercher des fichiers OpenAPI.

N’incluez pas de barre oblique initiale.

asyncapi · string or array or object

Fichiers de spécification AsyncAPI pour générer la documentation API. Peut être une seule URL/un seul chemin ou un tableau d’URL/de chemins.

Afficher Asyncapi

source · string

URL ou chemin vers votre fichier de spécification AsyncAPI.

Longueur minimale : 1

directory · string

Répertoire dans lequel rechercher des fichiers AsyncAPI.

N’incluez pas de barre oblique initiale.

params · object

Paramètres d’affichage des paramètres d’API.

Afficher Params

expanded · "all" | "closed"

Indique s’il faut développer tous les paramètres par défaut. Valeur par défaut : closed.

playground · object

Paramètres du terrain de jeu API.

Afficher Playground

display · "interactive" | "simple" | "none"

Mode d’affichage du terrain de jeu API. Valeur par défaut : interactive.

proxy · boolean

Indique s’il faut faire transiter les requêtes API par un serveur proxy. Valeur par défaut : true.

examples · object

Paramètres pour les exemples API générés automatiquement.

Afficher Examples

languages · array of string

Langages d’exemple pour les Snippets API générés automatiquement

defaults · "required" | "all"

Indique s’il faut afficher les paramètres optionnels dans les exemples API. Valeur par défaut : all.

mdx · object

Paramètres pour les pages API générées à partir de fichiers MDX.

Afficher Mdx

auth · object

Configuration de l’authentification pour les requêtes API basées sur MDX.

Afficher Auth

method · "bearer" | "basic" | "key" | "cobo"

Méthode d’authentification pour les requêtes API.

name · string

Nom de l’authentification pour les requêtes API.

server · string or array

Configuration du serveur pour les requêtes API.

​

SEO et recherche

seo · object

Configurations d’indexation SEO.

Afficher SEO

metatags · object

Balises meta ajoutées à chaque page. Doivent être des paires clé-valeur valides. Voir la référence des balises meta courantes pour les options.

indexing · "navigable" | "all"

Indiquez quelles pages les moteurs de recherche doivent indexer. Choisissez navigable pour n’indexer que les pages présentes dans la navigation de votre docs.json ou all pour indexer toutes les pages. Par défaut : navigable.

search · object

Paramètres d’affichage de la recherche.

Afficher Search

prompt · string

Texte indicatif à afficher dans la barre de recherche.

​

Intégrations

intégrations · object

Intégrations de tiers.

Afficher Intégrations

Amplitude · object

Intégration d’Amplitude Analytics.

Afficher Amplitude

apiKey · string · requis

Votre clé API Amplitude.

Clearbit · object

Intégration d’enrichissement de données Clearbit.

Afficher Clearbit

publicApiKey · string · requis

Votre clé d’API Clearbit.

Fathom · object

Intégration de Fathom Analytics.

Afficher Fathom

siteId · string · requis

L’identifiant de votre site Fathom.

Front (intégration chat) · object

Intégration du chat Front.

Afficher Frontchat

snippetId · string · requis

L’ID de votre extrait de code Front Chat.

Longueur minimale : 6

GA4 · object

Intégration à Google Analytics 4.

Afficher GA4

measurementId · string matching ^G · requis

Votre ID de mesure Google Analytics 4.

Doit correspondre au motif : ^G

GTM · object

Intégration de Google Tag Manager.

Afficher Gtm

tagId · string matching ^G · requis

Votre identifiant de balise Google Tag Manager.

Doit correspondre au motif : ^G

Heap · object

Intégration à Heap Analytics.

Afficher Heap

appId · string · requis

Votre ID d’application Heap.

Hotjar · object

Intégration à Hotjar.

Afficher Hotjar

hjid · string · requis

Votre identifiant Hotjar.

hjsv · string · requis

La version du script Hotjar.

Intercom · object

Intégration à Intercom.

Afficher Intercom

appId · string · requis

L’ID de votre application Intercom.

Longueur minimale : 6

koala · object

Intégration de Koala.

Afficher Koala

publicApiKey · string · requis

Votre clé d’API publique Koala.

Longueur minimale : 2

LogRocket · object

Intégration LogRocket.

Afficher LogRocket

appId · string · requis

L’ID d’application de votre projet LogRocket.

Mixpanel · object

Intégration à Mixpanel.

Afficher Mixpanel

projectToken · string · requis

Votre jeton de projet Mixpanel.

Osano · object

Intégration à Osano.

Afficher Osano

scriptSource · string · requis

Source de votre script Osano.

Pirsch · object

Intégration de Pirsch Analytics.

Afficher Pirsch

id · string · requis

Votre ID Pirsch.

PostHog · object

Intégration PostHog.

Afficher PostHog

apiKey · string matching ^phc\_ · requis

Votre clé API PostHog.

Doit correspondre au motif : ^phc_

apiHost · string (uri)

Votre hôte de l’API PostHog.

Plausible · object

Intégration à Plausible Analytics.

Afficher Plausible

domain · string · requis

Votre domaine Plausible.

server · string

Votre serveur Plausible.

Segment · object

Intégration de Segment.

Afficher Segment

key · string · requis

Votre clé Segment.

télémétrie · object

Paramètres de télémétrie.

Afficher Telemetry

enabled · boolean

Indique s’il faut activer la télémétrie.

cookies · object

Paramètres de cookies.

Afficher Cookies

key · string

Clé du cookie.

value · string

Valeur du cookie.

​

Erreurs

errors · object

Paramètres de gestion des erreurs.

Afficher Erreurs

404 · object

Gestion de l’erreur 404 « Page non trouvée ».

Afficher 404

redirect · boolean

Indique s’il faut rediriger automatiquement vers la page d’accueil lorsqu’une page est introuvable.

title · string

Titre personnalisé pour la page d’erreur 404.

description · string

Description personnalisée pour la page d’erreur 404. Prend en charge le formatage Markdown.

​

Exemples

Exemple de base

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. est une entreprise qui fournit du contenu d’exemple et du texte factice.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Documentation",
        "icon": "book",
        "description": "Comment utiliser le produit Example Co.",
        "groups": [
          {
            "group": "Bien démarrer",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "Personnalisation",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "Facturation",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "Journal des modifications",
        "icon": "history",
        "description": "Mises à jour et changements",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Communauté",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Commencer",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Ressources",
        "items": [
          {
            "label": "Clients",
            "href": "https://example.com/customers"
          },
          {
            "label": "Offre Entreprise",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Demander un aperçu",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Entreprise",
        "items": [
          {
            "label": "Carrières",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Politique de confidentialité",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "koala": {
      "publicApiKey": "pk_example_key_123"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "Introuvable",
      "description": "Qu’est-il arrivé à cette _page_ ?"
    }
  }
}

Exemple d’API interactif

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. est une entreprise qui fournit du contenu d’exemple et du texte de substitution.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Documentation",
        "icon": "book",
        "description": "Comment utiliser le produit Example Co.",
        "groups": [
          {
            "group": "Prise en main",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "Personnalisation",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "Facturation",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "Référence de l’API",
        "icon": "terminal",
        "description": "Comment utiliser l’API d’Example Co.",
        "groups": [
          {
            "group": "Référence de l’API",
            "pages": [
              "api-reference/introduction"
            ]
          },
          {
            "group": "Endpoints",
            "openapi": {
              "source": "openapi.json"
            }
          }
        ]
      },
      {
        "dropdown": "Journal des modifications",
        "icon": "history",
        "description": "Mises à jour et changements",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "api": {
    "playground": {
      "display": "interactive",
    },
    "examples": {
      "languages": ["javascript", "curl", "python"]
    }
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Communauté",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Commencer",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Ressources",
        "items": [
          {
            "label": "Clients",
            "href": "https://example.com/customers"
          },
          {
            "label": "Offre Entreprise",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Demander un aperçu",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Entreprise",
        "items": [
          {
            "label": "Carrières",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Politique de confidentialité",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "koala": {
      "publicApiKey": "pk_example_key_123"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "Introuvable",
      "description": "Que s’est-il donc passé avec cette _page_ ?"
    }
  }
}

Exemple multilingue

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. est une entreprise qui fournit du contenu d’exemple et du texte de remplissage.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "global": {
      "anchors": [
        {
          "anchor": "Documentation",
          "href": "https://mintlify.com/docs"
        },
        {
          "anchor": "Journal des modifications",
          "href": "https://mintlify.com/docs/changelog"
        }
      ]
    },
    "languages": [ 
      {
        "language": "en",
        "dropdowns": [
          {
            "dropdown": "Documentation",
            "icon": "book",
            "description": "Comment utiliser le produit Example Co.",
            "pages": [
              {
                "group": "Pour commencer",
                "pages": ["index", "quickstart"]
              },
              {
                "group": "Personnalisation",
                "pages": ["settings", "users", "features"]
              },
              {
                "group": "Facturation",
                "pages": [
                  "billing/overview",
                  "billing/payments",
                  "billing/subscriptions"
                ]
              }
            ]
          },
          {
            "dropdown": "Journal des modifications",
            "icon": "history",
            "description": "Mises à jour et modifications",
            "pages": ["changelog"]
          }
        ]
      },
      {
        "language": "es",
        "dropdowns": [
          {
            "dropdown": "Documentación",
            "icon": "book",
            "description": "Cómo usar el producto de Example Co.",
            "pages": [
              {
                "group": "Comenzando",
                "pages": ["es/index", "es/quickstart"]
              },
              {
                "group": "Personalización",
                "pages": ["es/settings", "es/users", "es/features"]
              },
              {
                "group": "Billing",
                "pages": [
                  "es/billing/overview",
                  "es/billing/payments",
                  "es/billing/subscriptions"
                ]
              }
            ]
          },
          {
            "dropdown": "Changelog",
            "icon": "history",
            "description": "Actualizaciones y cambios",
            "pages": ["es/changelog"]
          }
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Communauté",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Commencer",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Ressources",
        "items": [
          {
            "label": "Clients",
            "href": "https://example.com/customers"
          },
          {
            "label": "Offre Entreprise",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Demander un aperçu",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Société",
        "items": [
          {
            "label": "Carrières",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Politique de confidentialité",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "koala": {
      "publicApiKey": "pk_example_key_123"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": ["copy", "view", "chatgpt", "claude"]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "Introuvable",
      "description": "Qu’est-il arrivé à cette _page_ ?"
    }
  }
}

​

Mise à niveau depuis mint.json

Si votre projet de documentation utilise le fichier obsolète mint.json, suivez ces étapes pour passer à docs.json.

1. Installer ou mettre à jour la CLI

   Si vous n’avez pas encore installé la CLI, installez-la maintenant :

   npm

   npm i -g mint
   

   Si la CLI est déjà installée, assurez-vous qu’elle est à jour :

   mint update
   
2. Créer votre fichier docs.json

   Dans votre dépôt de documentation, exécutez :

   mint upgrade
   

   Cette commande créera un fichier docs.json à partir de votre mint.json existant. Passez en revue le fichier généré pour vérifier que tous les paramètres sont corrects.

3. Supprimer votre fichier mint.json

   Après avoir confirmé que votre docs.json est correctement configuré, vous pouvez supprimer en toute sécurité votre ancien fichier mint.json.