Paramètres globaux

Configurez les paramètres à l’échelle du site 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 personnalisé. Ce fichier de configuration requis contrôle le style, la navigation, les intégrations, et plus encore. Pensez-y comme au 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 qu’à spécifier theme, name, colors.primary et navigation. Les autres champs sont facultatifs et vous pourrez les ajouter au fil de l’évolution de vos besoins en matière de documentation.

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

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

​

Référence

Cette section présente 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 Themes 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 les thèmes. Si vous ne fournissez qu’une couleur principale, elle sera utilisée pour tous les éléments colorés.

Afficher Colors

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 l’accentuation 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 l’accentuation 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 de 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 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 votre fichier de logo pour le mode clair. Incluez l’extension du fichier. Exemple : /logo.png

dark · string · requis

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

href · string (uri)

L’URL vers laquelle rediriger lors d’un clic sur le logo. Si non renseigné, le logo pointera 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 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 Thumbnails

appearance · "light" | "dark"

Le thème visuel de vos vignettes. S’il n’est pas spécifié, les vignettes utilisent le jeu de couleurs de votre site défini 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

Configurations de style visuel.

Afficher Styling

eyebrows · "section" | "breadcrumbs"

Le style de l’eyebrow de la page. Choisissez section pour afficher le nom de la section ou breadcrumbs pour afficher le chemin de navigation complet. Valeur par défaut : section.

codeblocks · "system" | "dark"

Le thème des blocs de code. Choisissez system pour correspondre au thème du site ou dark pour des blocs de code toujours sombres. Valeur par défaut : system.

icons · object

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

Afficher Icônes

library · "fontawesome" | "lucide" · requis

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

Vous pouvez indiquer une URL vers une icône hébergée en externe, un chemin de fichier d’icône dans votre projet, ou du code SVG (Scalable Vector Graphics) compatible JSX pour n’importe quelle icône, quel que soit le paramétrage de la bibliothèque.

fonts · object

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

Afficher Polices

family · string · requis

Famille de polices, par exemple « Open Sans ».

weight · number

Graisse (épaisseur) de la police, par exemple 400 ou 700. Les polices variables acceptent des valeurs 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 sont chargées automatiquement lorsque vous renseignez un nom de family Google Font, aucune URL de source n’est donc nécessaire.

format · "woff" | "woff2"

Format du fichier de police.

heading · object

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

Afficher Titres

family · string · requis

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

weight · number

Graisse (épaisseur) de la police, par exemple 400, 700. Les polices variables acceptent des valeurs 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 sont chargées automatiquement lorsque vous renseignez un nom de family Google Font, aucune URL de source n’est donc nécessaire.

format · "woff" | "woff2"

Format du fichier de police.

body · object

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

Afficher Texte courant

family · string · requis

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

weight · number

Graisse (épaisseur) de la police, par exemple 400, 700. Les polices variables acceptent des valeurs 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 sont chargées automatiquement lorsque vous renseignez un nom de family Google Font, aucune URL de source n’est donc nécessaire.

format · "woff" | "woff2"

Format du fichier de police.

appearance · object

Paramètres de la bascule de mode clair/sombre.

Afficher Apparence

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

Mode de thème par défaut. Choisissez system pour suivre le réglage 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 la bascule clair/sombre. Par défaut : true.

background · object

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

Afficher Arrière-plan

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 Couleur

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 pointant vers des liens externes.

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

Cible du lien. Doit être une URL externe valide.

icon · string

L’icône à afficher.

Options :

• nom de l’icône Font Awesome
• nom de l’icône Lucide
• code SVG (compatible JSX) entouré d’accolades
• URL vers 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 à l’aide du 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. Entourez le code SVG compatible JSX avec des accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width si nécessaire.

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 un label ou github pour un lien vers un référentiel GitHub avec icon.

label · string · requis

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

href · string (uri) · requis

Cible du bouton. Doit être une URL externe. Si type est github, il doit s’agir de l’URL d’un référentiel GitHub.

navigation · object · requis

La structure de navigation de votre contenu.

Afficher Navigation

global · object

Éléments de navigation globaux qui apparaissent sur toutes les 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 la version de votre documentation dans cette langue.

versions · array of object

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

Afficher Versions

version · string · requis

Nom d’affichage 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 de l’icône Font Awesome
• nom de l’icône Lucide
• code SVG (compatible JSX) entouré d’accolades
• URL vers 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 à l’aide du 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. Entourez le code SVG compatible JSX avec des accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width si nécessaire.

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 si cet onglet est masqué par défaut.

href · string (uri) · requis

URL ou chemin vers la destination de l’onglet.

ancres · array of object

Des liens d’ancrage qui apparaissent de manière bien visible dans la navigation de la barre latérale.

Afficher Ancres

anchor · string · requis

Nom d’affichage de l’ancre.

Longueur minimale : 1

icon · string

L’icône à afficher.

Options :

• nom de l’icône Font Awesome
• nom de l’icône Lucide
• code SVG (compatible JSX) entouré d’accolades
• URL vers 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 à l’aide du 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. Entourez le code SVG compatible JSX avec des accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width si nécessaire.

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 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 de l’ancre pour le mode sombre.

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

hidden · boolean

Indique si cette ancre doit être 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 d’affichage du menu déroulant.

Longueur minimale : 1

icon · string

L’icône à afficher.

Options :

• nom de l’icône Font Awesome
• nom de l’icône Lucide
• code SVG (compatible JSX) entouré d’accolades
• URL vers 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 à l’aide du 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. Entourez le code SVG compatible JSX avec des accolades : icon={<svg ...> ... </svg>}.
5. Ajustez height et width si nécessaire.

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 version pour les sites proposant plusieurs versions.

Onglets · array of object

Onglets de navigation de niveau supérieur tabs.

ancres · array of object

Ancres de la barre latérale : anchors.

menus déroulants · array of object

Menus déroulants pour regrouper du contenu connexe.

groups · array of object

Groupes pour organiser le contenu en sections.

pages · array of string or object

Des 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 l’ouverture de 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 key est un nom de plateforme et chaque value 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

Bandeau de site affiché en haut des pages.

Afficher Banner

content · string

Contenu du bandeau. Prend en charge le texte brut et la mise en forme Markdown. Par exemple :

{
  "content": "🚀 Le bandeau est en ligne ! [En savoir plus](mintlify.com)"
}

dismissible · boolean

Indique si les utilisateurs peuvent fermer le bandeau. 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 du contenu optimisé par l’IA et des 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 : Copie l’URL de votre serveur MCP dans le presse-papiers.
• cursor : Installe votre serveur MCP hébergé dans Cursor.
• vscode : Installe votre serveur MCP hébergé dans VSCode.

Le menu contextuel est disponible uniquement sur les aperçus et les déploiements de production.

​

Configurations de l’API

api · object

Paramètres de la documentation de l’API et du bac à sable interactif.

Afficher Api

openapi · string or array or object

Fichiers de spécification OpenAPI pour générer la documentation de l’API. Peut être une seule URL/un seul chemin ou un tableau d’URL/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 de l’API. Peut être une seule URL/un seul chemin ou un tableau d’URL/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 de l’API.

Afficher Params

expanded · "all" | "closed"

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

playground · object

Paramètres du bac à sable d’API.

Afficher Playground

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

Mode d’affichage du bac à sable d’API. Par défaut : interactive.

proxy · boolean

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

examples · object

Configurations des exemples d’API générés automatiquement.

Afficher Examples

languages · array of string

Langues des extraits d’API générés automatiquement

defaults · "required" | "all"

Indique s’il faut afficher les paramètres facultatifs dans les exemples d’API. Par défaut : all.

mdx · object

Configurations des pages d’API générées à partir de fichiers MDX.

Afficher Mdx

auth · object

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

Afficher Auth

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

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

name · string

Nom d’authentification pour les requêtes d’API.

server · string or array

Configuration du serveur pour les requêtes d’API.

​

SEO et recherche

seo · object

Configurations d’indexation SEO.

Afficher Seo

metatags · object

Balises meta ajoutées à chaque page. Doit être une paire key-value valide. Consultez la référence des balises meta courantes pour connaître les options.

indexing · "navigable" | "all"

Indique quelles pages les moteurs de recherche doivent indexer. Choisissez navigable pour indexer uniquement les pages présentes dans la navigation de votre docs.json, ou all pour indexer chaque page. Valeur par défaut : navigable.

search · object

Paramètres d’affichage de la recherche.

Afficher Search

prompt · string

Texte d’espace réservé affiché dans la barre de recherche.

​

Intégrations

Integrations · object

Intégrations tierces.

Afficher Intégrations

Amplitude · object

Intégration à 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é API Clearbit.

Fathom · object

Intégration Fathom Analytics.

Afficher Fathom

siteId · string · requis

L’ID de votre site Fathom.

Front Chat · object

Intégration de Front Chat.

Afficher Frontchat

snippetId · string · requis

Votre identifiant de snippet 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 modèle : ^G

GTM · object

Intégration à 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 d’Analytics Heap.

Afficher Heap

appId · string · requis

Votre ID d’application Heap.

Hotjar · object

Intégration de 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

Votre ID d’app Intercom.

Longueur minimale : 6

koala · object

Intégration Koala.

Afficher Koala

publicApiKey · string · requis

Votre clé API publique Koala.

Longueur minimale : 2

LogRocket · object

Intégration LogRocket.

Afficher LogRocket

appId · string · requis

L’ID d’application 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

La source de votre script Osano.

Pirsch · object

Intégration Pirsch Analytics.

Afficher Pirsch

id · string · requis

Votre identifiant Pirsch.

PostHog · object

Intégration PostHog.

Afficher PostHog

apiKey · string matching ^phc\_ · requis

Votre clé API PostHog.

Doit respecter le motif : ^phc_

apiHost · string (uri)

Votre hôte de l’API PostHog.

Plausible · object

Intégration Plausible Analytics.

Afficher Plausible

domain · string · requis

Votre domain Plausible.

server · string

Votre serveur Plausible.

Segment · object

Intégration à Segment.

Afficher Segment

key · string · requis

Votre key Segment.

télémétrie · object

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

Afficher Télémétrie

enabled · boolean

Indique si la télémétrie est activée.

cookies · object

Paramètres des cookies.

Afficher Cookies

key · string

key des cookies.

value · string

value des cookies.

​

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 la mise en forme Markdown.

​

Exemples

Exemple simple

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": {
    "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": "Journal des modifications",
        "icon": "history",
        "description": "Mises à jour et modifications",
        "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": "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 donc **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 API",
        "icon": "terminal",
        "description": "Comment utiliser l'API Example Co.",
        "groups": [
          {
            "group": "Référence API",
            "pages": [
              "api-reference/introduction"
            ]
          },
          {
            "group": "Points de terminaison",
            "openapi": {
              "source": "openapi.json"
            }
          }
        ]
      },
      {
        "dropdown": "Journal des modifications",
        "icon": "history",
        "description": "Mises à jour et modifications",
        "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": "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 substitution.",
  "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": "Premiers pas",
                "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": "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": "Page introuvable",
      "description": "Qu'est-il **arrivé** à cette _page_ ?"
    }
  }
}

​

Mise à niveau depuis mint.json

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

1. Installer ou mettre à jour l’interface en ligne de commande (CLI)

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

   npm

   npm i -g mint
   

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

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

   Dans votre référentiel de documentation, exécutez :

   mint upgrade
   

   Cette commande va créer 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 vérifié que votre docs.json est correctement configuré, vous pouvez supprimer en toute sécurité votre ancien fichier mint.json.