Aller au contenu principal

Paramètres globaux

Chaque site Mintlify nécessite un fichier docs.json avec les paramètres de configuration principaux. En savoir plus sur les propriétés ci-dessous.

Propriétés​

namestringrequired

Nom de votre projet. Utilisé pour le titre global.

Exemple : mintlify

navigationNavigation[]required

Un tableau de groupes avec toutes les pages de chaque groupe

Navigation
groupstring

Le nom du groupe.

Exemple : Paramètres

pagesstring[]

Les chemins relatifs vers les fichiers markdown qui serviront de pages.

Exemple : ["customization", "page"]

logostring or object

Chemin vers l'image du logo ou objet avec le chemin vers les images de logo en mode « clair » et « sombre »

Logo
lightstring

Chemin vers le logo en mode clair

darkstring

Chemin vers le logo en mode sombre

hrefstring

Lien vers lequel redirige le clic sur le logo

faviconstring

Chemin vers l'image favicon

colorsColors

Codes couleur hexadécimaux pour votre thème global

Couleurs
primarystringrequired

La couleur principale. Utilisée le plus souvent pour le contenu mis en valeur, les en-têtes de section et les accents, en mode clair

lightstring

La couleur principale pour le mode sombre. Utilisée le plus souvent pour le contenu mis en valeur, les en-têtes de section et les accents, en mode sombre

darkstring

La couleur principale pour les boutons importants

backgroundobject

La couleur de fond en mode clair et sombre

Objet
lightstringrequired

Le code couleur hexadécimal du fond en mode clair

darkstringrequired

Le code couleur hexadécimal du fond en mode sombre

topbarLinksTopbarLink[]

Tableau des noms et urls des liens que vous souhaitez inclure dans la barre supérieure

TopbarLink
namestring

Le nom du bouton.

Exemple : Contactez-nous

urlstring

L'URL vers laquelle pointe le bouton. Exemple : https://mintlify.com/docs

topbarCtaButtonCall to Action
Bouton d'appel à l'action de la barre supérieure
type"link" or "github"

Link affiche un bouton. GitHub affiche les informations du dépôt à l'URL fournie, y compris le nombre d'étoiles GitHub.

urlstring

Si link : Vers quoi pointe le bouton.

Si github : Lien vers le dépôt depuis lequel charger les informations GitHub.

namestring

Texte à l'intérieur du bouton. Requis uniquement si type est un link.

versionsstring[]

Tableau de noms de versions. À utiliser uniquement si vous souhaitez afficher différentes versions de la documentation avec un menu déroulant dans la barre de navigation.

anchorsAnchor[]

Un tableau des ancres, incluant l'icône, la couleur et l'url.

Ancre
iconstring

L'icône Font Awesome utilisée pour représenter l'ancre.

Exemple : comments

namestring

Le nom de l'étiquette de l'ancre.

Exemple : Communauté

urlstring

Le début de l'URL qui indique quelles pages sont dans l'ancre. Généralement, c'est le nom du dossier où se trouvent vos pages.

colorstring

La couleur hexadécimale de l'arrière-plan de l'icône de l'ancre. Peut aussi être un dégradé si vous passez un objet avec les propriétés from et to qui sont chacune une couleur hexadécimale.

versionstring

Utilisé si vous souhaitez masquer une ancre jusqu'à ce que la bonne version de documentation soit sélectionnée.

isDefaultHiddenboolean

Passez true si vous souhaitez masquer l'ancre jusqu'à ce que vous fournissiez un lien direct vers la documentation à l'intérieur.

iconTypestring

Une des valeurs suivantes : « brands », « duotone », « light », « sharp-solid », « solid » ou « thin »

topAnchorObject

Remplacez les configurations par défaut pour l'ancre la plus haute.

Objet
namestring

Le nom de l'ancre la plus haute

iconstring

Icône Font Awesome.

iconTypestring

Une des valeurs suivantes : « brands », « duotone », « light », « sharp-solid », « solid » ou « thin »

tabsTabs[]

Un tableau d'onglets de navigation.

Onglets
namestring

Le nom de l'étiquette de l'onglet.

urlstring

Le début de l'URL qui indique quelles pages sont dans l'onglet. Généralement, c'est le nom du dossier où se trouvent vos pages.

apiAPI

Configuration pour les paramètres API. En savoir plus sur les pages API dans Composants API.

API
baseUrlstring

L'URL de base pour tous les endpoints API. Si baseUrl est un tableau, cela activera plusieurs options d'URL de base que l'utilisateur pourra basculer.

authAuth
Authentification
method"bearer" | "basic" | "key"

La stratégie d'authentification utilisée pour tous les endpoints API.

namestring

Le nom du paramètre d'authentification utilisé dans le terrain de jeu API.

Si la méthode est basic, le format doit être [nomUtilisateur]:[nomMotDePasse]

inputPrefixstring

La valeur par défaut conçue comme préfixe pour le champ de saisie d'authentification.

Par exemple, si un inputPrefix de AuthKey hérite du résultat de saisie par défaut du champ d'authentification comme AuthKey.

playgroundPlayground

Configurations pour le terrain de jeu API

Terrain de jeu
mode"show" | "simple" | "hide"

Si le terrain de jeu est affiché, masqué ou affiche uniquement l'endpoint sans interactivité utilisateur ajoutée (simple)

En savoir plus dans les guides du terrain de jeu

maintainOrderboolean

Activer ce drapeau garantit que l'ordre des clés dans les pages OpenAPI correspond à l'ordre des clés défini dans le fichier OpenAPI.

attention
Ce comportement sera bientôt activé par défaut, au moment où ce champ sera déprécié.
openapistring | string[]

Une chaîne ou un tableau de chaînes d'URL(s) ou de chemin(s) relatifs pointant vers votre fichier OpenAPI.

Exemples :

"openapi": "https://example.com/openapi.json"
"openapi": "/openapi.json"
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
footerSocialsFooterSocials

Un objet de comptes de réseaux sociaux où la paire clé:propriété représente la plateforme de réseau social et l'URL du compte.

Exemple :

{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}
Réseaux sociaux du pied de page
[key]string

Une des valeurs suivantes : website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

Exemple : x

propertystring

L'URL vers la plateforme sociale.

Exemple : https://x.com/mintlify

feedbackFeedback

Configurations pour activer les boutons de feedback

Feedback
suggestEditboolean

Active un bouton permettant aux utilisateurs de suggérer des modifications via des pull requests

raiseIssueboolean

Active un bouton permettant aux utilisateurs de signaler un problème concernant la documentation

modeToggleModeToggle

Personnalisez le bouton de basculement du mode sombre.

ModeToggle
default"light" or "dark"

Définissez si vous souhaitez toujours afficher le mode clair ou sombre pour les nouveaux utilisateurs. Lorsque non défini, nous utilisons par défaut le même mode que le système d'exploitation de l'utilisateur.

isHiddenboolean

Définissez sur true pour masquer le bouton de basculement clair/sombre. Vous pouvez combiner isHidden avec default pour forcer votre documentation à utiliser uniquement le mode clair ou sombre. Par exemple :

"modeToggle": {
  "default": "dark",
  "isHidden": true
}
"modeToggle": {
  "default": "light",
  "isHidden": true
}
backgroundImagestring

Une image d'arrière-plan à afficher derrière chaque page. Voir l'exemple avec Infisical et FRPC.