diff --git a/es/organize/navigation.mdx b/es/organize/navigation.mdx index 38326a027..8d5fea252 100644 --- a/es/organize/navigation.mdx +++ b/es/organize/navigation.mdx @@ -277,7 +277,7 @@ Los menús añaden elementos de navegación desplegables a una Tab. Usa los men En el objeto `navigation`, `menu` es un array donde cada entrada es un objeto que requiere un campo `item` y puede incluir otros campos de navegación como groups, pages, icon o enlaces a páginas externas. -Los elementos de menú solo pueden contener groups, pages y enlaces externos. +Un elemento de menú puede contener páginas, un enlace externo mediante `href`, o cualquier división de navegación (`groups`, `tabs`, `anchors`, `dropdowns`, `products`, `languages` o `versions`). Usa una división dentro de un elemento de menú cuando quieras que esa columna muestre el mismo tipo de navegación anidada que la división ofrece en el nivel superior. ```json { @@ -403,7 +403,7 @@ Los anclajes globales admiten tanto URL externas como rutas relativas a páginas Los productos crean una sección de navegación dedicada para organizar la documentación específica de cada producto. Usa productos para separar distintas ofertas, servicios o conjuntos de funciones principales dentro de tu documentación. -En el objeto `navigation`, `products` es un arreglo donde cada entrada es un objeto que requiere un campo `product` y puede contener otros campos de navegación como groups, pages, icons o enlaces a páginas externas. +En el objeto `navigation`, `products` es un arreglo donde cada entrada es un objeto que requiere un campo `product` y puede contener otros campos de navegación como groups, pages, un [menu](#menús), icons o enlaces a páginas externas. ```json { @@ -451,6 +451,53 @@ En el objeto `navigation`, `products` es un arreglo donde cada entrada es un obj } ``` +
+ ### Menús de producto +
+ +Agrega un arreglo `menu` a un producto para crear un menú desplegable de varias columnas para ese producto. Cada elemento del menú requiere un campo `item` y puede contener páginas, un enlace externo mediante `href`, o cualquier división de navegación (`groups`, `tabs`, `anchors`, `dropdowns`, `products`, `languages` o `versions`). Esta es la misma forma de `menu` que se admite en [tabs](#menús), y resulta útil cuando un producto tiene varias áreas de contenido distintas que quieres mostrar desde el selector de productos. + +```json +{ + "navigation": { + "products": [ + { + "product": "Core API", + "icon": "api", + "menu": [ + { + "item": "Guías", + "icon": "book-open", + "groups": [ + { + "group": "Primeros pasos", + "pages": [ + "core-api/quickstart", + "core-api/authentication" + ] + } + ] + }, + { + "item": "Referencia de la API", + "icon": "square-terminal", + "pages": [ + "core-api/users", + "core-api/orders" + ] + }, + { + "item": "Changelog", + "icon": "list", + "href": "https://example.com/changelog" + } + ] + } + ] + } +} +``` + @@ -1096,4 +1143,4 @@ Cuando un usuario expande un grupo de navigation, algunos temas navegan automát "drilldown": false // No navegar nunca, solo expandir o contraer el grupo } ``` - \ No newline at end of file + diff --git a/es/organize/settings-reference.mdx b/es/organize/settings-reference.mdx index 77d5ff179..4b721cbc8 100644 --- a/es/organize/settings-reference.mdx +++ b/es/organize/settings-reference.mdx @@ -220,9 +220,9 @@ Menús desplegables. #### `navigation.products` -Selector de productos. +Selector de productos. Cada entrada requiere un campo `product` y puede contener groups, pages, un arreglo `menu` (con la misma forma que `navigation.tabs[].menu`, para menús desplegables de producto de varias columnas), iconos o enlaces externos. -**Tipo:** array of object—consulta `navigation.global.products` para la estructura. +**Tipo:** array of object—cada uno con: `product` (string, requerido), `description` (string), `icon` (string), `iconType` (string), `href` (string uri), `groups` (array), `pages` (array), `menu` (array) #### `navigation.groups` diff --git a/fr/organize/navigation.mdx b/fr/organize/navigation.mdx index a031e6560..6f9f9124d 100644 --- a/fr/organize/navigation.mdx +++ b/fr/organize/navigation.mdx @@ -5,11 +5,11 @@ keywords: ["structure de navigation", "configuration de la barre latérale", "or boost: 3 --- -La propriété [navigation](/fr/organize/settings-structure#navigation) dans `docs.json` détermine la structure et la hiérarchie de l’information de votre documentation. +La propriété [navigation](/fr/organize/settings-structure#navigation) dans `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. +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. +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 @@ -21,7 +21,7 @@ Les pages sont le composant de navigation le plus élémentaire. Chaque page est Représentation décorative de pages. -Dans l'objet `navigation`, `pages` est un tableau dont chaque entrée doit référencer le chemin d’accès à un [fichier de page](/fr/organize/pages). +Dans l'objet `navigation`, `pages` est un tableau dont chaque entrée doit référencer le chemin d'accès à un [fichier de page](/fr/organize/pages). ```json { @@ -80,7 +80,7 @@ Utilisez des groupes pour organiser la navigation de votre barre latérale en se Graphique décoratif représentant des groupes. -Dans l’objet `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`, `root` et `expanded` sont facultatifs. +Dans l'objet `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`, `root` et `expanded` sont facultatifs. ```json { @@ -121,7 +121,7 @@ Dans l’objet `navigation`, `groups` est un tableau où chaque entrée est un o ### Page racine
-Utilisez la propriété `root` pour désigner une page principale pour un groupe. Lorsqu'un groupe a une page racine, cliquer sur le titre du groupe dans la barre latérale de navigation ouvre la page racine. Les pages racines fonctionnent pour les groupes de premier niveau comme pour les groupes imbriqués. +Utilisez la propriété `root` pour désigner une page principale pour un groupe. Lorsqu'un groupe a une page racine, cliquer sur le titre du groupe dans la barre latérale de navigation ouvre la page racine. Les pages racines fonctionnent pour les groupes de premier niveau comme pour les groupes imbriqués. ```json Example group with a root page { @@ -202,13 +202,13 @@ La valeur de `directory` est héritée à travers la hiérarchie de navigation. ### État développé par défaut -Utilisez la propriété `expanded` pour contrôler l’état par défaut d’un groupe imbriqué dans la barre latérale de navigation. +Utilisez la propriété `expanded` pour contrôler l'état par défaut d'un groupe imbriqué dans la barre latérale de navigation. * `expanded: true` : développe le groupe par défaut. * `expanded: false` ou omis : réduit le groupe 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 se développent toujours et vous ne pouvez pas les réduire. + La propriété `expanded` n'affecte que les groupes imbriqués — des groupes à l'intérieur d'autres groupes. Les groupes de premier niveau se développent toujours et vous ne pouvez pas les réduire. ```json @@ -229,13 +229,13 @@ Utilisez la propriété `expanded` pour contrôler l’état par défaut d’un ## Tabs -Les Tabs créent des sections distinctes de votre documentation avec des chemins d’URL séparés. Les Tabs génèrent une barre de navigation horizontale en haut de votre documentation qui permet aux utilisateurs de passer d’une section à l’autre. +Les Tabs créent des sections distinctes de votre documentation avec des chemins d'URL séparés. Les Tabs génèrent une barre de navigation horizontale en haut de votre documentation qui permet aux utilisateurs de passer d'une section à l'autre. -Graphique décoratif d’une navigation par onglets. +Graphique décoratif d'une navigation par onglets. -Graphique décoratif d’une navigation par onglets. +Graphique décoratif d'une navigation par onglets. -Dans l’objet `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. +Dans l'objet `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. ```json { @@ -273,11 +273,11 @@ Dans l’objet `navigation`, `tabs` est un tableau où chaque entrée est un obj ### Menus -Les menus ajoutent des éléments de navigation déroulants à un onglet. Utilisez-les pour aider les utilisateurs à accéder directement à des pages spécifiques au sein d’un onglet. +Les menus ajoutent des éléments de navigation déroulants à un onglet. Utilisez-les pour aider les utilisateurs à accéder directement à des pages spécifiques au sein d'un onglet. -Dans l’objet `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. +Dans l'objet `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. +Un élément de menu peut contenir des pages, un lien externe via `href`, ou n'importe quelle division de navigation (`groups`, `tabs`, `anchors`, `dropdowns`, `products`, `languages` ou `versions`). Utilisez une division dans un élément de menu lorsque vous souhaitez que cette colonne affiche le même type de navigation imbriquée que la division propose au niveau supérieur. ```json { @@ -323,13 +323,13 @@ Les éléments de menu peuvent uniquement contenir des groupes, des pages et des ## Ancres -Les ancres ajoutent des éléments de navigation persistants en haut de votre barre latérale. Utilisez-les pour structurer votre contenu, offrir un accès rapide à des ressources externes ou créer des appels à l’action bien visibles. +Les ancres ajoutent des éléments de navigation persistants en haut de votre barre latérale. Utilisez-les pour structurer votre contenu, offrir un accès rapide à des ressources externes ou créer des appels à l'action bien visibles. -Image décorative d’une navigation avec ancres. +Image décorative d'une navigation avec ancres. -Image décorative d’une navigation avec ancres. +Image décorative d'une navigation avec ancres. -Dans l’objet `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. +Dans l'objet `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. ```json { @@ -366,7 +366,7 @@ Dans l’objet `navigation`, `tabs` est un tableau où chaque entrée est un obj ### Ancres globales -Utilisez des ancres globales pour les liens qui doivent apparaître sur toutes les pages, quelle que soit la section de votre navigation que l’utilisateur consulte. Les ancres globales sont particulièrement utiles pour créer des liens vers des ressources en dehors de votre documentation (comme un blog, un forum communautaire ou un portail d’assistance) ou pour fournir un accès cohérent à des pages internes importantes (comme un journal des modifications ou une page de statut). +Utilisez des ancres globales pour les liens qui doivent apparaître sur toutes les pages, quelle que soit la section de votre navigation que l'utilisateur consulte. Les ancres globales sont particulièrement utiles pour créer des liens vers des ressources en dehors de votre documentation (comme un blog, un forum communautaire ou un portail d'assistance) ou pour fournir un accès cohérent à des pages internes importantes (comme un journal des modifications ou une page de statut). Les ancres globales prennent en charge aussi bien les URL externes que les chemins relatifs vers des pages de votre documentation. @@ -397,13 +397,13 @@ Les ancres globales prennent en charge aussi bien les URL externes que les chemi ## Produits -Illustration décorative d’un sélecteur de produit. +Illustration décorative d'un sélecteur de produit. -Illustration décorative d’un sélecteur de produit. +Illustration décorative d'un sélecteur de produit. Les produits créent une section de navigation dédiée pour organiser la documentation propre à chaque produit. Utilisez les produits pour séparer différentes offres, services ou grands ensembles de fonctionnalités au sein de votre documentation. -Dans l’objet `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. +Dans l'objet `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, un [menu](#menus), des icons ou des liens vers des pages externes. ```json { @@ -451,17 +451,64 @@ Dans l’objet `navigation`, `products` est un tableau où chaque entrée est un } ``` +
+ ### Menus de produit +
+ +Ajoutez un tableau `menu` à un produit pour créer un menu déroulant multi-colonnes pour ce produit. Chaque élément du menu exige un champ `item` et peut contenir des pages, un lien externe via `href`, ou n'importe quelle division de navigation (`groups`, `tabs`, `anchors`, `dropdowns`, `products`, `languages` ou `versions`). Il s'agit de la même structure de `menu` que celle prise en charge sous les [tabs](#menus), utile lorsqu'un produit comporte plusieurs zones de contenu distinctes que vous souhaitez exposer depuis le sélecteur de produits. + +```json +{ + "navigation": { + "products": [ + { + "product": "Core API", + "icon": "api", + "menu": [ + { + "item": "Guides", + "icon": "book-open", + "groups": [ + { + "group": "Prise en main", + "pages": [ + "core-api/quickstart", + "core-api/authentication" + ] + } + ] + }, + { + "item": "Référence d'API", + "icon": "square-terminal", + "pages": [ + "core-api/users", + "core-api/orders" + ] + }, + { + "item": "Changelog", + "icon": "list", + "href": "https://example.com/changelog" + } + ] + } + ] + } +} +``` + -Les menus déroulants constituent un menu extensible en haut de la navigation de votre barre latérale. Chaque élément d’un menu déroulant mène à une section de votre documentation. +Les menus déroulants constituent un menu extensible en haut de la navigation de votre barre latérale. Chaque élément d'un menu déroulant mène à une section de votre documentation. -Graphique décoratif d’une navigation avec menu déroulant. +Graphique décoratif d'une navigation avec menu déroulant. -Graphique décoratif d’une navigation avec menu déroulant. +Graphique décoratif d'une navigation avec menu déroulant. -Dans l’objet `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. +Dans l'objet `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. ```json { @@ -499,9 +546,9 @@ Dans l’objet `navigation`, `dropdowns` est un tableau où chaque entrée est u ## OpenAPI -Intégrez des spécifications OpenAPI directement dans votre structure de navigation afin de générer automatiquement la documentation de votre API. Créez des sections d’API dédiées ou placez des pages d’endpoints au sein d’autres composants de navigation. +Intégrez des spécifications OpenAPI directement dans votre structure de navigation afin de générer automatiquement la documentation de votre API. Créez des sections d'API dédiées ou placez des pages d'endpoints au sein d'autres composants de navigation. -Définissez une spécification OpenAPI par défaut à n’importe quel niveau de votre hiérarchie de navigation. Les éléments enfants héritent de cette spécification, sauf s’ils définissent leur propre spécification. +Définissez une spécification OpenAPI par défaut à n'importe quel niveau de votre hiérarchie de navigation. Les éléments enfants héritent de cette spécification, sauf s'ils définissent leur propre spécification. 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. @@ -509,7 +556,7 @@ Définissez une spécification OpenAPI par défaut à n’importe quel niveau de Pour contrôler les endpoints qui apparaissent, énumérez explicitement les endpoints souhaités dans un tableau `pages`. -Pour plus d’informations sur la manière de référencer des endpoints OpenAPI dans votre documentation, consultez la page [Configuration d’OpenAPI](/fr/api-playground/openapi-setup). +Pour plus d'informations sur la manière de référencer des endpoints OpenAPI dans votre documentation, consultez la page [Configuration d'OpenAPI](/fr/api-playground/openapi-setup). ```json { @@ -543,13 +590,13 @@ Pour plus d’informations sur la manière de référencer des endpoints OpenAPI ## Versions -Divisez votre navigation en différentes versions. Les versions peuvent être sélectionnées à partir d’un menu déroulant. +Divisez votre navigation en différentes versions. Les versions peuvent être sélectionnées à partir d'un menu déroulant. -Illustration décorative d’un sélecteur de version. +Illustration décorative d'un sélecteur de version. -Illustration décorative d’un sélecteur de version. +Illustration décorative d'un sélecteur de version. -Dans l’objet `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. +Dans l'objet `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. ```json { @@ -616,7 +663,7 @@ Mintlify utilise la première version du tableau `versions` comme version par d ### Tags de version -Ajoutez un badge aux entrées de version dans le menu déroulant du sélecteur de version à l'aide du champ facultatif `tag`. Utilisez des tags pour mettre en avant des versions spécifiques comme « Dernière », « Recommandée » ou « Bêta ». +Ajoutez un badge aux entrées de version dans le menu déroulant du sélecteur de version à l'aide du champ facultatif `tag`. Utilisez des tags pour mettre en avant des versions spécifiques comme « Dernière », « Recommandée » ou « Bêta ». ```json { @@ -662,13 +709,13 @@ Ajoutez un badge aux entrées de version dans le menu déroulant du sélecteur d ## Langues -Répartissez votre navigation en différentes langues. Les langues peuvent être sélectionnées à partir d’un menu déroulant. +Répartissez votre navigation en différentes langues. Les langues peuvent être sélectionnées à partir d'un menu déroulant. -Graphique décoratif d’un sélecteur de langue. +Graphique décoratif d'un sélecteur de langue. -Graphique décoratif d’un sélecteur de langue. +Graphique décoratif d'un sélecteur de langue. -Dans l’objet `navigation`, `languages` est un tableau où chaque entrée est un objet qui requiert un champ `language` et peut contenir tout autre champ de navigation, y compris des configurations de bannière, de pied de page et de barre de navigation spécifiques à la langue. +Dans l'objet `navigation`, `languages` est un tableau où chaque entrée est un objet qui requiert un champ `language` et peut contenir tout autre champ de navigation, y compris des configurations de bannière, de pied de page et de barre de navigation spécifiques à la langue. Nous prenons actuellement en charge les langues suivantes pour la localisation : @@ -817,16 +864,16 @@ Nous prenons actuellement en charge les langues suivantes pour la localisation : } ``` -Pour les traductions automatisées, [configurez un workflow](/workflows) pour exécuter l’agent selon un calendrier ou en réponse à des pushes vers le dépôt. +Pour les traductions automatisées, [configurez un workflow](/workflows) pour exécuter l'agent selon un calendrier ou en réponse à des pushes vers le dépôt.
## Imbrication
-Vous pouvez imbriquer des éléments de navigation les uns dans les autres pour créer des hiérarchies complexes. Vous devez avoir un élément de navigation parent au niveau racine, comme des Onglets, des groupes ou un menu déroulant. Vous pouvez imbriquer d’autres types d’éléments de navigation dans votre structure de navigation principale. +Vous pouvez imbriquer des éléments de navigation les uns dans les autres pour créer des hiérarchies complexes. Vous devez avoir un élément de navigation parent au niveau racine, comme des Onglets, des groupes ou un menu déroulant. Vous pouvez imbriquer d'autres types d'éléments de navigation dans votre structure de navigation principale. -Chaque élément de navigation peut contenir un type d’élément enfant à chaque niveau de votre hiérarchie de navigation. Par exemple, un Onglet peut contenir des ancres qui contiennent des groupes, mais un Onglet ne peut pas contenir à la fois des ancres et des groupes au même niveau. +Chaque élément de navigation peut contenir un type d'élément enfant à chaque niveau de votre hiérarchie de navigation. Par exemple, un Onglet peut contenir des ancres qui contiennent des groupes, mais un Onglet ne peut pas contenir à la fois des ancres et des groupes au même niveau. @@ -1047,10 +1094,10 @@ Chaque élément de navigation peut contenir un type d’élément enfant à cha -Le fil d’Ariane affiche le chemin de navigation complet en haut des pages. Certains thèmes activent le fil d’Ariane par défaut, d’autres non. Vous pouvez contrôler l’affichage du fil d’Ariane sur votre site à l’aide de la propriété `styling` dans votre `docs.json`. +Le fil d'Ariane affiche le chemin de navigation complet en haut des pages. Certains thèmes activent le fil d'Ariane par défaut, d'autres non. Vous pouvez contrôler l'affichage du fil d'Ariane sur votre site à l'aide de la propriété `styling` dans votre `docs.json`. @@ -1072,22 +1119,22 @@ Le fil d’Ariane affiche le chemin de navigation complet en haut des pages. Cer ## Configuration des interactions -Contrôlez la manière dont les utilisateurs interagissent avec les éléments de navigation à l'aide de la propriété `interaction` dans votre `docs.json`. +Contrôlez la manière dont les utilisateurs interagissent avec les éléments de navigation à l'aide de la propriété `interaction` dans votre `docs.json`.
### Activer la navigation automatique pour les groupes
-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`. +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 `true` pour forcer la navigation automatique vers la première page lorsqu’un utilisateur sélectionne un groupe de navigation. -* Définissez `false` pour empêcher la navigation et uniquement développer ou réduire le groupe lorsqu’un utilisateur sélectionne un groupe de navigation. +* Définissez `true` pour forcer la navigation automatique vers la première page lorsqu'un utilisateur sélectionne un groupe de navigation. +* Définissez `false` pour empêcher la navigation et uniquement développer ou réduire le groupe lorsqu'un utilisateur sélectionne un groupe de navigation. * Laissez la valeur non définie pour utiliser le comportement par défaut du thème. ```json Forcer la navigation "interaction": { - "drilldown": true // Forcer la navigation vers la première page lorsqu’un utilisateur ouvre un menu déroulant + "drilldown": true // Forcer la navigation vers la première page lorsqu'un utilisateur ouvre un menu déroulant } ``` @@ -1096,4 +1143,4 @@ Lorsqu’un utilisateur ouvre un groupe de navigation, certains thèmes redirige "drilldown": false // Ne jamais naviguer, uniquement développer ou réduire le groupe } ``` - \ No newline at end of file + diff --git a/fr/organize/settings-reference.mdx b/fr/organize/settings-reference.mdx index 2728ac495..8e0b16c97 100644 --- a/fr/organize/settings-reference.mdx +++ b/fr/organize/settings-reference.mdx @@ -220,9 +220,9 @@ Menus déroulants. #### `navigation.products` -Sélecteur de produits. +Sélecteur de produits. Chaque entrée requiert un champ `product` et peut contenir des groups, pages, un tableau `menu` (même structure que `navigation.tabs[].menu`, pour des menus déroulants de produit multi-colonnes), des icônes ou des liens externes. -**Type :** array of object—voir `navigation.global.products` pour la structure. +**Type :** array of object—chacun avec : `product` (string, requis), `description` (string), `icon` (string), `iconType` (string), `href` (string uri), `groups` (array), `pages` (array), `menu` (array) #### `navigation.groups` diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 22c07d018..1302ac2f4 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -16,15 +16,14 @@ Choose one primary organizational pattern at the root level of your navigation. Pages are the most fundamental navigation component. Each page is an MDX file in your documentation repository. Decorative graphic of pages. - Decorative graphic of pages. In the `navigation` object, `pages` is an array where each entry must reference the path to a [page file](/organize/pages). @@ -48,15 +47,14 @@ In the `navigation` object, `pages` is an array where each entry must reference Use groups to organize your sidebar navigation into sections. You can nest groups within each other, label them with tags, and style them with icons. Decorative graphic of groups. - Decorative graphic of groups. In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, `root`, and `expanded` fields are optional. @@ -124,7 +122,7 @@ Use the `directory` property to automatically render a directory of child pages The `directory` property accepts three values: | Value | Behavior | -| :---------- | :------- | +| :-- | :-- | | `"none"` | No directory listing. Default value. | | `"accordion"` | Displays child pages in a collapsible list grouped by section. | | `"card"` | Displays child pages in a horizontal card layout. | @@ -167,6 +165,7 @@ You can set `directory` anywhere in the navigation object in your `docs.json` fi ``` In this example: + - **Help Center** uses `"accordion"` and its root page displays a directory listing. - **Getting Started** inherits `"accordion"` from its parent and also displays a directory listing. - **API Reference** overrides with `"none"`, so its root page does not display a directory listing. @@ -205,15 +204,14 @@ Use the `expanded` property to control the default state of a nested group in th Tabs create distinct sections of your documentation with separate URL paths. Tabs create a horizontal navigation bar at the top of your documentation that lets users switch between sections. Decorative graphic of a tab navigation. - Decorative graphic of a tab navigation. In the `navigation` object, `tabs` is an array where each entry is an object that requires a `tab` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. @@ -256,7 +254,7 @@ Menus add dropdown navigation items to a tab. Use menus to help users go directl In the `navigation` object, `menu` is an array where each entry is an object that requires an `item` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. -Menu items can only contain groups, pages, and external links. +A menu item can hold pages, an external link via `href`, or any navigation division (`groups`, `tabs`, `anchors`, `dropdowns`, `products`, `languages`, or `versions`). Use a division inside a menu item when you want that column to render the same kind of nested navigation that the division provides at the top level. ```json { @@ -303,15 +301,14 @@ Menu items can only contain groups, pages, and external links. Anchors add persistent navigation items to the top of your sidebar. Use anchors to section your content, provide quick access to external resources, or create prominent calls to action. Decorative graphic of an anchor navigation. - Decorative graphic of an anchor navigation. In the `navigation` object, `anchors` is an array where each entry is an object that requires an `anchor` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. @@ -378,20 +375,19 @@ Global anchors support both external URLs and relative paths to pages within you ## Products Decorative graphic of a product switcher. - Decorative graphic of a product switcher. Products create a dedicated navigation division for organizing product-specific documentation. Use products to separate different offerings, services, or major feature sets within your documentation. -In the `navigation` object, `products` is an array where each entry is an object that requires a `product` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. +In the `navigation` object, `products` is an array where each entry is an object that requires a `product` field and can contain other navigation fields such as groups, pages, a [menu](#menus), icons, or links to external pages. ```json { @@ -439,20 +435,64 @@ In the `navigation` object, `products` is an array where each entry is an object } ``` +### Product menus + +Add a `menu` array to a product to render its product switcher entry as a multi-column dropdown. Each menu item requires an `item` field and can contain pages, an external link via `href`, or any navigation division (`groups`, `tabs`, `anchors`, `dropdowns`, `products`, `languages`, or `versions`). This is the same `menu` shape supported under [tabs](#menus), and is useful when a product has several distinct content areas that you want to surface from the product switcher. + +```json +{ + "navigation": { + "products": [ + { + "product": "Core API", + "icon": "api", + "menu": [ + { + "item": "Guides", + "icon": "book-open", + "groups": [ + { + "group": "Getting started", + "pages": [ + "core-api/quickstart", + "core-api/authentication" + ] + } + ] + }, + { + "item": "API reference", + "icon": "square-terminal", + "pages": [ + "core-api/users", + "core-api/orders" + ] + }, + { + "item": "Changelog", + "icon": "list", + "href": "https://example.com/changelog" + } + ] + } + ] + } +} +``` + ## Dropdowns Dropdowns are an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation. Decorative graphic of a dropdown navigation. - Decorative graphic of a dropdown navigation. In the `navigation` object, `dropdowns` is an array where each entry is an object that requires a `dropdown` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. @@ -496,7 +536,7 @@ Set a default OpenAPI specification at any level of your navigation hierarchy. C When you add the `openapi` property to a navigation element (such as an anchor, tab, or group) without specifying any pages, Mintlify automatically generates pages for **all endpoints** defined in your OpenAPI specification. - + To control which endpoints appear, explicitly list the desired endpoints in a `pages` array. @@ -534,15 +574,14 @@ For more information about referencing OpenAPI endpoints in your docs, see the [ Partition your navigation into different versions. Versions are selectable from a dropdown menu. Decorative graphic of a version switcher. - Decorative graphic of a version switcher. In the `navigation` object, `versions` is an array where each entry is an object that requires a `version` field and can contain any other navigation fields. @@ -654,15 +693,14 @@ Add a badge label to version entries in the version selector dropdown using the Partition your navigation into different languages. Languages are selectable from a dropdown menu. Decorative graphic of a language switcher. - Decorative graphic of a language switcher. In the `navigation` object, `languages` is an array where each entry is an object that requires a `language` field and can contain any other navigation fields, including language-specific banner, footer, and navbar configurations. @@ -1044,6 +1082,7 @@ When a user expands a navigation group, some themes automatically navigate to th - Leave unset to use the theme's default behavior. + ```json Force navigation "interaction": { "drilldown": true // Force navigation to first page when a user expands a dropdown @@ -1055,4 +1094,5 @@ When a user expands a navigation group, some themes automatically navigate to th "drilldown": false // Never navigate, only expand or collapse the group } ``` + diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx index cfdb22d88..e0e24daae 100644 --- a/organize/settings-reference.mdx +++ b/organize/settings-reference.mdx @@ -218,9 +218,9 @@ Dropdown menus. #### `navigation.products` -Product switcher. +Product switcher. Each entry requires a `product` field and can contain groups, pages, a `menu` array (same shape as `navigation.tabs[].menu`, for multi-column product dropdowns), icons, or external links. -**Type:** array of object—see `navigation.global.products` for shape. +**Type:** array of object—each with: `product` (string, required), `description` (string), `icon` (string), `iconType` (string), `href` (string uri), `groups` (array), `pages` (array), `menu` (array) #### `navigation.groups` diff --git a/zh/organize/navigation.mdx b/zh/organize/navigation.mdx index e38d53fee..b34c9a9c8 100644 --- a/zh/organize/navigation.mdx +++ b/zh/organize/navigation.mdx @@ -244,7 +244,7 @@ boost: 3 在 `navigation` 对象中，`menu` 是一个数组，其中每个条目都是一个对象，必须包含 `item` 字段，并且可以包含其他导航字段，例如 groups、pages、icons，或指向外部页面的链接。 -菜单项只能包含 groups、pages 和外部链接。 +菜单项可以包含页面、通过 `href` 指向的外部链接，或任意导航分区（`groups`、`tabs`、`anchors`、`dropdowns`、`products`、`languages` 或 `versions`）。如果希望某一列呈现与顶级相同的嵌套导航结构，可以在菜单项中使用对应的分区。 ```json { @@ -368,9 +368,9 @@ boost: 3 产品切换器的装饰性图形。 -“产品”用于在导航中创建专门的分区，以组织针对特定产品的文档。使用“产品”将文档中的不同产品、服务或重要功能集彼此区分开。 +"产品"用于在导航中创建专门的分区，以组织针对特定产品的文档。使用"产品"将文档中的不同产品、服务或重要功能集彼此区分开。 -在 `navigation` 对象中，`products` 是一个数组，其中每个条目都是一个对象，必须包含 `product` 字段，并且可以包含其他导航字段，例如 groups、pages、icons，或指向外部页面的链接。 +在 `navigation` 对象中，`products` 是一个数组，其中每个条目都是一个对象，必须包含 `product` 字段，并且可以包含其他导航字段，例如 groups、pages、[menu](#菜单)、icons，或指向外部页面的链接。 ```json { @@ -418,6 +418,53 @@ boost: 3 } ``` +
+ ### 产品菜单 +
+ +在产品中添加 `menu` 数组，可为该产品创建一个多列下拉菜单。每个菜单项必须包含 `item` 字段，并可包含页面、通过 `href` 指向的外部链接，或任意导航分区（`groups`、`tabs`、`anchors`、`dropdowns`、`products`、`languages` 或 `versions`）。这与 [tabs](#菜单) 下支持的 `menu` 结构相同，适用于希望从产品切换器中暴露多个独立内容区的产品。 + +```json +{ + "navigation": { + "products": [ + { + "product": "Core API", + "icon": "api", + "menu": [ + { + "item": "指南", + "icon": "book-open", + "groups": [ + { + "group": "快速入门", + "pages": [ + "core-api/quickstart", + "core-api/authentication" + ] + } + ] + }, + { + "item": "API 参考", + "icon": "square-terminal", + "pages": [ + "core-api/users", + "core-api/orders" + ] + }, + { + "item": "更新日志", + "icon": "list", + "href": "https://example.com/changelog" + } + ] + } + ] + } +} +``` + @@ -584,7 +631,7 @@ Mintlify 使用 `versions` 数组中的第一个版本作为默认版本。使 ### 版本标签 -使用可选的 `tag` 字段，在版本选择器的下拉菜单中为各版本条目添加徽章标签。使用这些标签来突出显示特定版本，例如 “Latest”、“Recommended” 或 “Beta”。 +使用可选的 `tag` 字段，在版本选择器的下拉菜单中为各版本条目添加徽章标签。使用这些标签来突出显示特定版本，例如 "Latest"、"Recommended" 或 "Beta"。 ```json { @@ -1062,4 +1109,4 @@ Mintlify 使用 `versions` 数组中的第一个版本作为默认版本。使 "drilldown": false // 从不跳转，仅展开或折叠该分组 } ``` - \ No newline at end of file +