7. Comment fonctionne le fichier mintlify.json

Comment fonctionne le fichier mintlify.json

Comprendre le fichier central de configuration Mintlify

À quoi sert le fichier mintlify.json ?

Le fichier mintlify.json est le cœur de la configuration de votre site Mintlify.

Il contrôle :

• la navigation (sidebar)
• les titres et sections
• les groupes de pages
• les paramètres généraux du site
• les liens externes
• certains comportements visuels

Chaque fois que vous modifiez la structure de votre documentation, c’est ce fichier qui organise l’ensemble.

Où se trouve ce fichier ?

Dans votre projet Mintlify :

• il se trouve à la racine du dossier
• il est automatiquement mis à jour lorsque vous modifiez la navigation via l’interface Mintlify

Vous pouvez aussi l’éditer manuellement si vous préférez un contrôle total.

Structure générale du fichier

Le fichier contient généralement :

• un titre global
• une description
• une section “navigation”
• des groupes de pages
• des liens externes éventuels

Chaque élément est organisé sous forme de blocs simples et lisibles.

Comment fonctionne la navigation ?

La section “navigation” du fichier mintlify.json détermine :

• l’ordre des pages
• les sections principales
• les sous‑sections
• les regroupements logiques

Chaque entrée correspond à une page ou un groupe.

Si une page n’apparaît pas dans la sidebar, c’est souvent parce qu’elle n’est pas listée dans cette section.

Modifier la navigation

Vous pouvez :

• ajouter une nouvelle page
• déplacer une page dans une autre section
• renommer une section
• créer un groupe de pages
• masquer temporairement un élément

Toutes ces actions peuvent être faites soit via l’interface Mintlify, soit en modifiant directement le fichier JSON.

Bonnes pratiques

• gardez une structure simple et logique
• évitez les sections trop longues
• regroupez les pages par thème
• vérifiez régulièrement la cohérence de la navigation
• mettez à jour la sidebar quand vous ajoutez une nouvelle page

Une bonne organisation rend votre documentation plus agréable à parcourir.

Résumé

Le fichier mintlify.json contrôle toute la structure de votre documentation.

Il définit la navigation, les sections et l’organisation générale du site.

Le comprendre permet de personnaliser votre documentation de manière propre et efficace.

Pour aller plus loin

• Documentation Mintlify : https://mintlify.com/docs/navigation
• Exemples de configuration : https://mintlify.com/templates