5. Comment fonctionne la sidebar Mintlify

Comprendre la sidebar Mintlify

Comment organiser et structurer votre documentation

À quoi sert la sidebar ?

La sidebar est le menu latéral de votre documentation.

Elle permet aux utilisateurs de naviguer facilement entre vos pages.

Une bonne sidebar rend votre site clair, logique et agréable à parcourir.

Mintlify génère automatiquement la sidebar à partir du fichier mintlify.json, mais vous pouvez la personnaliser entièrement.

Structure générale de la sidebar

La sidebar est composée de :

• sections
• sous‑sections
• pages individuelles
• groupes de pages

Chaque élément peut être réorganisé, renommé ou masqué.

Où modifier la sidebar ?

Vous pouvez modifier la sidebar de deux façons :

1. Depuis l’interface Mintlify

Dans votre projet :

• ouvrez l’onglet Navigation
• ajoutez, supprimez ou déplacez des pages
• créez des sections
• renommez les éléments

C’est la méthode la plus simple pour les débutants.

2. Depuis le fichier mintlify.json

Pour les utilisateurs plus avancés, vous pouvez éditer directement la structure dans le fichier JSON.

Chaque entrée correspond à une section ou une page.

Comment organiser une bonne sidebar ?

Voici quelques principes simples :

• regroupez les pages par thème
• mettez les pages importantes en haut
• évitez les sections trop longues
• utilisez des titres clairs et courts
• gardez une logique de progression pour les débutants

Une bonne sidebar doit permettre à quelqu’un qui découvre votre site de comprendre immédiatement où cliquer.

Exemple d’organisation logique

Une structure efficace pourrait ressembler à :

• Introduction
• Premiers pas
• Tutoriels
• Référence
• Guides avancés

L’objectif est de guider l’utilisateur sans le perdre.

Conseils pratiques

• évitez les titres trop techniques
• ne créez pas trop de niveaux de profondeur
• vérifiez régulièrement la cohérence de vos sections
• mettez à jour la sidebar quand vous ajoutez de nouvelles pages

Une sidebar propre donne une impression de qualité et de sérieux.

Résumé

La sidebar est le cœur de la navigation de votre documentation.

Elle doit être claire, logique et organisée.

Mintlify vous permet de la modifier facilement via l’interface ou le fichier JSON.

Pour aller plus loin

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