Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions es/organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,47 @@ Usa la propiedad `expanded` para controlar el estado predeterminado de un grupo
}
```

<div id="tree-navigation">
### Navegación en árbol
</div>

Usa la propiedad `mode` para mostrar un árbol de navegación en las páginas raíz de grupo. Cuando `mode` se establece en `"tree"`, las páginas raíz muestran automáticamente un listado de sus páginas secundarias y grupos anidados, proporcionando a los usuarios una visión clara del contenido de la sección.

* `mode: "tree"`: muestra un árbol de navegación en la página raíz del grupo con las páginas secundarias y los grupos anidados.
* `mode: "auto"` o si se omite: usa el comportamiento predeterminado sin árbol de navegación.

La propiedad `mode` se hereda de forma recursiva. Cuando estableces `mode` en un elemento padre (como el objeto `navigation` raíz, una pestaña, un ancla o un producto), todos los grupos descendientes heredan ese modo. Los descendientes pueden sobrescribir el modo heredado estableciendo su propio valor de `mode`.

```json
{
"navigation": {
"groups": [
{
"group": "Referencia de API",
"root": "api-overview",
"mode": "tree",
"pages": [
"api-reference/authentication",
{
"group": "Endpoints",
"root": "api-reference/endpoints-overview",
"pages": [
"api-reference/get",
"api-reference/post",
"api-reference/delete"
]
}
]
}
]
}
}
```

<Note>
La navegación en árbol requiere una página `root` en el grupo. El árbol de navegación se muestra en la página raíz, listando todas las páginas secundarias y grupos anidados de esa sección.
</Note>

<div id="tabs">
## Tabs
</div>
Expand Down
4 changes: 4 additions & 0 deletions es/organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,10 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp
Selector de productos para sitios con múltiples [productos](/es/organize/navigation#products).
</ResponseField>

<ResponseField name="navigation.mode" type='"auto" | "tree"'>
Modo de navegación para todos los grupos y sus descendientes. Establece en `"tree"` para mostrar un árbol de navegación en las páginas raíz de grupo, mostrando las páginas secundarias y los grupos anidados. Se hereda de forma recursiva; los grupos, pestañas, anclas u otros elementos de navegación pueden sobrescribir este valor individualmente. Por defecto: `"auto"`. Ver [Navegación en árbol](/es/organize/navigation#tree-navigation).
</ResponseField>

<ResponseField name="navigation.groups" type="array of object">
[Grupos](/es/organize/navigation#groups) para organizar el contenido en secciones.
</ResponseField>
Expand Down
41 changes: 41 additions & 0 deletions fr/organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,47 @@ Utilisez la propriété `expanded` pour contrôler l’état par défaut d’un
}
```

<div id="tree-navigation">
### Navigation arborescente
</div>

Utilisez la propriété `mode` pour afficher un arbre de navigation sur les pages racines de groupe. Lorsque `mode` est défini sur `"tree"`, les pages racines affichent automatiquement une liste de leurs pages enfants et groupes imbriqués, offrant aux utilisateurs un aperçu clair du contenu de la section.

* `mode: "tree"` : affiche un arbre de navigation sur la page racine du groupe, montrant les pages enfants et les groupes imbriqués.
* `mode: "auto"` ou omis : utilise le comportement par défaut, sans arbre de navigation.

La propriété `mode` est héritée de manière récursive. Lorsque vous définissez `mode` sur un élément parent (comme l'objet `navigation` racine, un onglet, une ancre ou un produit), tous les groupes descendants héritent de ce mode. Les descendants peuvent remplacer le mode hérité en définissant leur propre valeur `mode`.

```json
{
"navigation": {
"groups": [
{
"group": "Référence API",
"root": "api-overview",
"mode": "tree",
"pages": [
"api-reference/authentication",
{
"group": "Endpoints",
"root": "api-reference/endpoints-overview",
"pages": [
"api-reference/get",
"api-reference/post",
"api-reference/delete"
]
}
]
}
]
}
}
```

<Note>
La navigation arborescente nécessite une page `root` sur le groupe. L'arbre de navigation est affiché sur la page racine, listant toutes les pages enfants et groupes imbriqués de cette section.
</Note>

<div id="tabs">
## Tabs
</div>
Expand Down
4 changes: 4 additions & 0 deletions fr/organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,10 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l
Sélecteur de produits pour les sites avec plusieurs [produits](/fr/organize/navigation#products).
</ResponseField>

<ResponseField name="navigation.mode" type='"auto" | "tree"'>
Mode de navigation pour tous les groupes et leurs descendants. Définissez sur `"tree"` pour afficher un arbre de navigation sur les pages racines des groupes, montrant les pages enfants et les groupes imbriqués. S'hérite de manière récursive ; les groupes, onglets, ancres ou autres éléments de navigation peuvent remplacer cette valeur individuellement. Par défaut : `"auto"`. Voir [Navigation arborescente](/fr/organize/navigation#tree-navigation).
</ResponseField>

<ResponseField name="navigation.groups" type="array of object">
[Groupes](/fr/organize/navigation#groups) pour organiser le contenu en sections.
</ResponseField>
Expand Down
61 changes: 61 additions & 0 deletions organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@

Use the `expanded` property to control the default state of a nested group in the navigation sidebar.

- `expanded: true`: Group is expanded by default.

Check warning on line 123 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L123

In general, use active voice instead of passive voice ('is expanded').
- `expanded: false` or omitted: Group is collapsed by default.

Check warning on line 124 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L124

In general, use active voice instead of passive voice ('is collapsed').

<Note>
The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed.

Check warning on line 127 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L127

In general, use active voice instead of passive voice ('be collapsed').
</Note>

```json
Expand All @@ -141,6 +141,67 @@
}
```

### Tree navigation

Use the `mode` property to display a navigation tree on group root pages. When `mode` is set to `"tree"`, root pages automatically render a listing of their child pages and nested groups, giving users a clear overview of the section's content.

- `mode: "tree"`: Renders a navigation tree on the group's root page showing child pages and child groups.
- `mode: "auto"` or omitted: Uses the default behavior with no navigation tree.

The `mode` property inherits recursively. When you set `mode` on a parent element (such as the root `navigation` object, a tab, an anchor, or a product), all descendant groups inherit that mode. Descendants can override the inherited mode by setting their own `mode` value.

```json
{
"navigation": {
"groups": [
{
"group": "API reference",
"root": "api-overview",
"mode": "tree",
"pages": [
"api-reference/authentication",
{
"group": "Endpoints",
"root": "api-reference/endpoints-overview",
"pages": [
"api-reference/get",
"api-reference/post",
"api-reference/delete"
]
}
]
}
]
}
}
```

You can also set `mode` at higher levels of the navigation hierarchy to apply tree navigation across all groups:

```json
{
"navigation": {
"mode": "tree",
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting started",
"root": "quickstart",
"pages": ["installation", "configuration"]
}
]
}
]
}
}
```

<Note>
Tree navigation requires a `root` page on the group. The navigation tree is rendered on the root page, listing all child pages and nested groups in that section.

Check warning on line 202 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L202

In general, use active voice instead of passive voice ('is rendered').
</Note>

## Tabs

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.
Expand Down Expand Up @@ -380,9 +441,9 @@
}
```

## Dropdowns

Check warning on line 444 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L444

Use 'dropdowns?' instead of '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.

Check warning on line 446 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L446

Use 'dropdowns?' instead of 'Dropdowns'.

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -950,9 +1011,9 @@

</CodeGroup>

## Breadcrumbs

Check warning on line 1014 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1014

Use 'breadcrumbs?' instead of 'Breadcrumbs'.

Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs display on your site using the `styling` property in your `docs.json`.

Check warning on line 1016 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L1016

Use 'breadcrumbs?' instead of 'Breadcrumbs'.

<CodeGroup>

Expand Down
4 changes: 4 additions & 0 deletions organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,10 @@
Product switcher for sites with multiple [products](/organize/navigation#products).
</ResponseField>

<ResponseField name="navigation.mode" type='"auto" | "tree"'>
Navigation mode for all groups and their descendants. Set to `"tree"` to render a navigation tree on group root pages, showing child pages and nested groups. Inherits recursively; individual groups, tabs, anchors, or other navigation elements can override this value. Defaults to `"auto"`. See [Tree navigation](/organize/navigation#tree-navigation).

Check warning on line 197 in organize/settings-structure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L197

Use semicolons judiciously.
</ResponseField>

<ResponseField name="navigation.groups" type="array of object">
[Groups](/organize/navigation#groups) for organizing content into sections.
</ResponseField>
Expand Down
41 changes: 41 additions & 0 deletions zh/organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,47 @@ keywords: ["导航结构", "侧边栏配置", "页面组织", "导航分组"]
}
```

<div id="tree-navigation">
### 树状导航
</div>

使用 `mode` 属性在分组根页面上显示导航树。当 `mode` 设置为 `"tree"` 时,根页面会自动渲染其子页面和嵌套分组的列表,为用户提供该部分内容的清晰概览。

* `mode: "tree"`:在分组的根页面上渲染导航树,显示子页面和嵌套分组。
* `mode: "auto"` 或省略:使用默认行为,不显示导航树。

`mode` 属性会递归继承。当你在父元素(如根 `navigation` 对象、选项卡、锚点或产品)上设置 `mode` 时,所有后代分组都会继承该模式。后代可以通过设置自己的 `mode` 值来覆盖继承的模式。

```json
{
"navigation": {
"groups": [
{
"group": "API 参考",
"root": "api-overview",
"mode": "tree",
"pages": [
"api-reference/authentication",
{
"group": "接口",
"root": "api-reference/endpoints-overview",
"pages": [
"api-reference/get",
"api-reference/post",
"api-reference/delete"
]
}
]
}
]
}
}
```

<Note>
树状导航需要分组设置 `root` 页面。导航树会在根页面上渲染,列出该部分中的所有子页面和嵌套分组。
</Note>

<div id="tabs">
## 选项卡
</div>
Expand Down
4 changes: 4 additions & 0 deletions zh/organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,10 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx";
多[产品](/zh/organize/navigation#products)站点的产品切换器。
</ResponseField>

<ResponseField name="navigation.mode" type='"auto" | "tree"'>
所有分组及其后代的导航模式。设置为 `"tree"` 可在分组根页面上渲染导航树,显示子页面和嵌套分组。递归继承;各分组、选项卡、锚点或其他导航元素可单独覆盖此值。默认值:`"auto"`。请参阅[树状导航](/zh/organize/navigation#tree-navigation)。
</ResponseField>

<ResponseField name="navigation.groups" type="object 数组">
用于将内容组织成部分的[组](/zh/organize/navigation#groups)。
</ResponseField>
Expand Down
Loading