docs.json détermine la structure et la hiérarchie de l’information de votre documentation.
Avec une configuration de navigation adéquate, vous pouvez organiser votre contenu pour que les utilisateurs trouvent exactement ce qu’ils recherchent.
Choisissez un modèle d’organisation principal à la racine de votre navigation. Une fois ce modèle principal choisi, vous pouvez y imbriquer d’autres éléments de navigation.
Pages

navigation, pages est un tableau dont chaque entrée doit référencer le chemin d’accès à un fichier de page.
Groupes

navigation, groups est un tableau où chaque entrée est un objet qui nécessite un champ group et un champ pages. Les champs icon, tag et expanded sont facultatifs.
État développé par défaut
expanded pour contrôler l’état par défaut d’un groupe imbriqué dans la barre latérale de navigation.
expanded: true: le groupe est développé par défaut.expanded: falseou omis : le groupe est réduit par défaut.
La propriété
expanded n’affecte que les groupes imbriqués — des groupes à l’intérieur d’autres groupes. Les groupes de premier niveau sont toujours développés et ne peuvent pas être réduits.Tabs

navigation, tabs est un tableau où chaque entrée est un objet qui requiert un champ tab et peut contenir d’autres champs de navigation tels que des groupes, des pages, des icons ou des liens vers des pages externes.
navigation, menu est un tableau où chaque entrée est un objet qui requiert un champ item et peut contenir d’autres champs de navigation tels que des groupes, des pages, des icon, ou des liens vers des pages externes.
Les éléments de menu peuvent uniquement contenir des groupes, des pages et des liens externes.
Ancres

navigation, tabs est un tableau où chaque entrée est un objet qui exige un champ anchor et peut contenir d’autres champs de navigation tels que des groupes, des pages, des icônes ou des liens vers des pages externes.
Ancres globales
Les ancres globales doivent inclure un champ
href pointant vers une URL externe. Elles ne peuvent pas contenir de chemins relatifs.Menus déroulants

navigation, dropdowns est un tableau où chaque entrée est un objet qui requiert un champ dropdown et peut contenir d’autres champs de navigation tels que des groups, des pages, des icon ou des liens vers des pages externes.
Produits

navigation, products est un tableau où chaque entrée est un objet qui exige un champ product et peut contenir d’autres champs de navigation tels que des groupes, des pages, des icons ou des liens vers des pages externes.
OpenAPI
Lorsque vous ajoutez la propriété
openapi à un élément de navigation (comme une ancre, un onglet ou un groupe) sans spécifier de pages, Mintlify génère automatiquement des pages pour tous les endpoints définis dans votre spécification OpenAPI.Pour contrôler les endpoints qui apparaissent, énumérez explicitement les endpoints souhaités dans un tableau pages.Versions

navigation, versions est un tableau dans lequel chaque entrée est un objet qui requiert un champ version et peut contenir n’importe quels autres champs de navigation.
Langues

navigation, languages est un tableau où chaque entrée est un objet qui doit contenir un champ language et peut inclure tout autre champ de navigation, y compris des configurations de bannières propres à chaque langue.
Nous prenons actuellement en charge les langues suivantes pour la localisation :

Arabe (ar)

Tchèque (cs)

Chinois (cn)

Chinois (zh-Hant)

Néerlandais (nl)

Anglais (en)

Français (fr)

Allemand (de)

Hébreu (he)

Hindi (hi)

Indonésien (id)

Italien (it)

Japonais (jp)

Coréen (ko)

Letton (lv)

Norvégien (no)

Polonais (pl)

Portugais (pt-BR)

Roumain (ro)

Russe (ru)

Espagnol (es)

Suédois (sv)

Turc (tr)

Ukrainien (ua)

Ouzbek (uz)

Vietnamien (vi)
Imbrication
styling dans votre docs.json.
Configuration des interactions
interaction dans votre docs.json.
Lorsqu’un utilisateur ouvre un groupe de navigation, certains thèmes redirigent automatiquement vers la première page du groupe. Vous pouvez modifier le comportement par défaut d’un thème avec l’option drilldown.
- Définissez
truepour forcer la navigation automatique vers la première page lorsqu’un groupe de navigation est sélectionné. - Définissez
falsepour empêcher la navigation et uniquement développer ou réduire le groupe lorsqu’il est sélectionné. - Laissez la valeur non définie pour utiliser le comportement par défaut du thème.







