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
40 changes: 40 additions & 0 deletions es/organize/hidden-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,46 @@ Para ocultar una Tab, añade la propiedad `hidden` para la Tab en tu archivo `do
]
```

<div id="keep-hidden-pages-discoverable-with-searchable">
## Mantener páginas ocultas detectables con `searchable`
</div>

De forma predeterminada, ocultar una tab, un grupo, un anchor o un dropdown también elimina sus páginas descendientes de la búsqueda, el sitemap, `llms.txt`, el assistant de IA y la indexación en motores de búsqueda. Para ocultar un elemento de navegación de la barra lateral sin perder la detectabilidad de sus páginas, agrega `searchable: true` junto con `hidden: true`.

Usa `searchable: true` cuando quieras que una sección sea accesible desde la búsqueda, el SEO o las herramientas de IA, pero sin que aparezca en la navegación renderizada. Casos comunes incluyen productos heredados que aún deben posicionarse en los motores de búsqueda, material de referencia enlazado solo desde otras páginas y contenido que quieras que el assistant de IA use como contexto.

```json highlight={4-5}
"tabs": [
{
"tab": "Reference",
"hidden": true,
"searchable": true,
"groups": [
{
"group": "Archived APIs",
"pages": [
"reference/legacy-api",
"reference/deprecated-endpoints"
]
}
]
}
]
```

Con esta configuración:

- Las páginas descendientes aparecen en la búsqueda del sitio y en el sitemap.
- Las páginas se incluyen en `llms.txt` y en el contexto del assistant de IA.
- El HTML renderizado no incluye `<meta name="robots" content="noindex">`, por lo que los motores de búsqueda pueden indexar las páginas.
- La tab, el grupo, el anchor o el dropdown sigue sin aparecer en la navegación lateral.

Puedes establecer `searchable: true` en cualquier elemento de navegación que admita `hidden`, incluidos tabs, grupos, anchors y dropdowns. Las páginas habilitadas mediante `searchable` siguen siendo accesibles por URL directa.

<Note>
`searchable: true` solo tiene efecto cuando también se establece `hidden: true`. En un elemento visible no hace nada.
</Note>

<div id="search-seo-and-ai-indexing">
## Búsqueda, SEO e indexación de IA
</div>
Expand Down
9 changes: 9 additions & 0 deletions es/organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp
<ResponseField name="hidden" type="boolean">
Si se debe ocultar esta pestaña de forma predeterminada.
</ResponseField>
<ResponseField name="searchable" type="boolean">
Cuando `hidden` es `true`, establece `searchable: true` para mantener las páginas descendientes en la búsqueda, el sitemap, `llms.txt` y el assistant de IA. Consulta [Páginas ocultas](/es/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL o ruta para el destino de la pestaña.
</ResponseField>
Expand Down Expand Up @@ -62,6 +65,9 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp
<ResponseField name="hidden" type="boolean">
Si se debe ocultar este ancla de forma predeterminada.
</ResponseField>
<ResponseField name="searchable" type="boolean">
Cuando `hidden` es `true`, establece `searchable: true` para mantener las páginas descendientes en la búsqueda, el sitemap, `llms.txt` y el assistant de IA. Consulta [Páginas ocultas](/es/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL o ruta para el destino del ancla.
</ResponseField>
Expand All @@ -79,6 +85,9 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp
<ResponseField name="hidden" type="boolean">
Si se debe ocultar este desplegable de forma predeterminada.
</ResponseField>
<ResponseField name="searchable" type="boolean">
Cuando `hidden` es `true`, establece `searchable: true` para mantener las páginas descendientes en la búsqueda, el sitemap, `llms.txt` y el assistant de IA. Consulta [Páginas ocultas](/es/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL o ruta para el destino del desplegable.
</ResponseField>
Expand Down
40 changes: 40 additions & 0 deletions fr/organize/hidden-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,46 @@ Pour masquer un onglet, ajoutez la propriété `hidden` pour l’onglet dans vot
]
```

<div id="keep-hidden-pages-discoverable-with-searchable">
## Garder les pages masquées détectables avec `searchable`
</div>

Par défaut, masquer un onglet, un groupe, une ancre ou un menu déroulant retire aussi ses pages descendantes de la recherche, du sitemap, de `llms.txt`, de l’Assistant IA et de l’indexation par les moteurs de recherche. Pour masquer un élément de navigation de la barre latérale tout en gardant ses pages détectables, ajoutez `searchable: true` en plus de `hidden: true`.

Utilisez `searchable: true` lorsque vous souhaitez qu’une section reste accessible via la recherche, le SEO ou les outils d’IA, sans qu’elle apparaisse dans la navigation rendue. Cas d’usage courants : produits historiques qui doivent encore être référencés dans les moteurs de recherche, contenus de référence reliés uniquement depuis d’autres pages, et contenus que vous voulez fournir comme contexte à l’Assistant IA.

```json highlight={4-5}
"tabs": [
{
"tab": "Reference",
"hidden": true,
"searchable": true,
"groups": [
{
"group": "Archived APIs",
"pages": [
"reference/legacy-api",
"reference/deprecated-endpoints"
]
}
]
}
]
```

Avec cette configuration :

- Les pages descendantes apparaissent dans la recherche du site et dans le sitemap.
- Les pages sont incluses dans `llms.txt` et dans le contexte de l’Assistant IA.
- Le HTML rendu ne contient pas `<meta name="robots" content="noindex">`, donc les moteurs de recherche peuvent indexer les pages.
- L’onglet, le groupe, l’ancre ou le menu déroulant n’apparaît toujours pas dans la navigation latérale.

Vous pouvez définir `searchable: true` sur tout élément de navigation qui prend en charge `hidden`, y compris les onglets, groupes, ancres et menus déroulants. Les pages activées via `searchable` restent accessibles par URL directe.

<Note>
`searchable: true` n’a d’effet que si `hidden: true` est également défini. Sur un élément visible, il n’a aucun effet.
</Note>

<div id="search-seo-and-ai-indexing">
## Recherche, SEO et indexation par l’IA
</div>
Expand Down
9 changes: 9 additions & 0 deletions fr/organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l
<ResponseField name="hidden" type="boolean">
Indique s'il faut masquer cet onglet par défaut.
</ResponseField>
<ResponseField name="searchable" type="boolean">
Lorsque `hidden` est `true`, définissez `searchable: true` pour conserver les pages descendantes dans la recherche, le sitemap, `llms.txt` et l’Assistant IA. Voir [Pages masquées](/fr/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL ou chemin de destination de l'onglet.
</ResponseField>
Expand Down Expand Up @@ -62,6 +65,9 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l
<ResponseField name="hidden" type="boolean">
Indique s'il faut masquer cette ancre par défaut.
</ResponseField>
<ResponseField name="searchable" type="boolean">
Lorsque `hidden` est `true`, définissez `searchable: true` pour conserver les pages descendantes dans la recherche, le sitemap, `llms.txt` et l’Assistant IA. Voir [Pages masquées](/fr/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL ou chemin de destination de l'ancre.
</ResponseField>
Expand All @@ -79,6 +85,9 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l
<ResponseField name="hidden" type="boolean">
Indique s'il faut masquer ce menu déroulant par défaut.
</ResponseField>
<ResponseField name="searchable" type="boolean">
Lorsque `hidden` est `true`, définissez `searchable: true` pour conserver les pages descendantes dans la recherche, le sitemap, `llms.txt` et l’Assistant IA. Voir [Pages masquées](/fr/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL ou chemin de destination du menu déroulant.
</ResponseField>
Expand Down
38 changes: 38 additions & 0 deletions organize/hidden-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
]
```

In this example, the `Getting started` group is hidden and the `Guides` group is visible.

Check warning on line 74 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L74

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

### Hide a tab

Expand All @@ -90,6 +90,44 @@
]
```

## Keep hidden pages discoverable with `searchable`

By default, hiding a tab, group, anchor, or dropdown also removes its descendant pages from search, the sitemap, `llms.txt`, the AI assistant, and search engine indexing. To hide a navigation element from the sidebar while keeping its pages discoverable, add `searchable: true` alongside `hidden: true`.

Use `searchable: true` when you want a section to be reachable through search, SEO, or AI tools, but not surfaced in the rendered navigation. Common cases include legacy products that should still rank in search results, reference material linked only from other pages, and content that you want the AI assistant to use as context.

```json highlight={4-5}
"tabs": [
{
"tab": "Reference",
"hidden": true,
"searchable": true,
"groups": [
{
"group": "Archived APIs",
"pages": [
"reference/legacy-api",
"reference/deprecated-endpoints"
]
}
]
}
]
```

With this configuration:

- Descendant pages appear in site search and the sitemap.
- Pages are included in `llms.txt` and the AI assistant's context.

Check warning on line 121 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L121

In general, use active voice instead of passive voice ('are included').
- Rendered HTML does not include `<meta name="robots" content="noindex">`, so search engines can index the pages.
- The tab, group, anchor, or dropdown still does not appear in the sidebar navigation.

You can set `searchable: true` on any navigation element that supports `hidden`, including tabs, groups, anchors, and dropdowns. Pages opted in through `searchable` are still reachable by direct URL.

<Note>
`searchable: true` only has an effect when `hidden: true` is also set. On a visible element it does nothing.
</Note>

## Search, SEO, and AI indexing

By default, hidden pages don't appear in indexing for search engines, documentation site search, or as AI assistant context. To include hidden pages in search results and assistant context, add the `seo` property to your `docs.json`:
Expand All @@ -105,5 +143,5 @@
The relationship between `hidden` and `noindex` is one-directional:

- **`hidden: true` → automatically applies `noindex`**: Hidden pages are automatically excluded from search engines, sitemaps, and AI context.
- **`noindex: true` → does NOT apply `hidden`**: Pages with `noindex: true` remain visible in navigation. They only affect search engine indexing and AI context.

Check warning on line 146 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L146

Spell out 'NOT', if it's unfamiliar to the audience.

Expand Down
9 changes: 9 additions & 0 deletions organize/settings-structure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Site structure"
description: "Configure navbar, navigation groups, footer links, banner, contextual menu, redirects, and other structural elements in your docs.json file."

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["navbar", "navigation", "footer", "banner", "contextual", "redirects", "variables", "metadata", "docs.json"]
---

Expand Down Expand Up @@ -33,6 +33,9 @@
<ResponseField name="hidden" type="boolean">
Whether to hide this tab by default.
</ResponseField>
<ResponseField name="searchable" type="boolean">
When `hidden` is `true`, set `searchable: true` to keep descendant pages in search, the sitemap, `llms.txt`, and the AI assistant. See [Hidden pages](/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL or path for the tab destination.
</ResponseField>
Expand Down Expand Up @@ -62,6 +65,9 @@
<ResponseField name="hidden" type="boolean">
Whether to hide this anchor by default.
</ResponseField>
<ResponseField name="searchable" type="boolean">
When `hidden` is `true`, set `searchable: true` to keep descendant pages in search, the sitemap, `llms.txt`, and the AI assistant. See [Hidden pages](/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL or path for the anchor destination.
</ResponseField>
Expand All @@ -79,6 +85,9 @@
<ResponseField name="hidden" type="boolean">
Whether to hide this dropdown by default.
</ResponseField>
<ResponseField name="searchable" type="boolean">
When `hidden` is `true`, set `searchable: true` to keep descendant pages in search, the sitemap, `llms.txt`, and the AI assistant. See [Hidden pages](/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable).
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
URL or path for the dropdown destination.
</ResponseField>
Expand Down Expand Up @@ -182,7 +191,7 @@
</ResponseField>

<ResponseField name="navigation.anchors" type="array of object">
Sidebar [anchors](/organize/navigation#anchors).

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L194

Use 'sidebars?' instead of 'Sidebar'.
</ResponseField>

<ResponseField name="navigation.dropdowns" type="array of object">
Expand All @@ -202,7 +211,7 @@
</ResponseField>

<ResponseField name="navigation.directory" type='"none" | "accordion" | "card"'>
Directory layout for root pages in navigation groups. When set, groups with a `root` page automatically display a listing of their children below the page content. Values inherit recursively through the navigation tree; descendants can override. See [Directory listings](/organize/navigation#directory-listings).

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L214

Use semicolons judiciously.
</ResponseField>

---
Expand Down
40 changes: 40 additions & 0 deletions zh/organize/hidden-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,46 @@ hidden: true
]
```

<div id="keep-hidden-pages-discoverable-with-searchable">
## 使用 `searchable` 让隐藏页面仍可被发现
</div>

默认情况下,隐藏一个标签页、分组、anchor 或 dropdown 也会让其下属页面从搜索、站点地图、`llms.txt`、AI 助手以及搜索引擎索引中移除。如果你希望某个导航元素不显示在侧边栏,但其页面仍可被发现,请在 `hidden: true` 旁同时设置 `searchable: true`。

当你希望某个版块能通过搜索、SEO 或 AI 工具访问到,但不希望它出现在渲染后的导航中时,请使用 `searchable: true`。常见场景包括:仍需在搜索引擎中获得排名的旧版产品、仅由其他页面链接的参考资料,以及希望作为 AI 助手上下文使用的内容。

```json highlight={4-5}
"tabs": [
{
"tab": "Reference",
"hidden": true,
"searchable": true,
"groups": [
{
"group": "Archived APIs",
"pages": [
"reference/legacy-api",
"reference/deprecated-endpoints"
]
}
]
}
]
```

应用此配置后:

- 下属页面会出现在站点搜索和站点地图中。
- 页面会被包含在 `llms.txt` 和 AI 助手的上下文里。
- 渲染后的 HTML 不会包含 `<meta name="robots" content="noindex">`,因此搜索引擎可以索引这些页面。
- 标签页、分组、anchor 或 dropdown 本身仍不会出现在侧边栏导航中。

你可以在任何支持 `hidden` 的导航元素上设置 `searchable: true`,包括标签页、分组、anchor 和 dropdown。通过 `searchable` 启用的页面仍可通过直接 URL 访问。

<Note>
只有同时设置 `hidden: true` 时,`searchable: true` 才会生效。对可见元素设置它不会产生任何作用。
</Note>

<div id="search-seo-and-ai-indexing">
## 搜索、SEO 与 AI 索引编入
</div>
Expand Down
9 changes: 9 additions & 0 deletions zh/organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx";
<ResponseField name="hidden" type="boolean">
是否默认隐藏此标签页。
</ResponseField>
<ResponseField name="searchable" type="boolean">
当 `hidden` 为 `true` 时,设置 `searchable: true` 可让下属页面继续出现在搜索、站点地图、`llms.txt` 以及 AI 助手中。请参阅[隐藏页面](/zh/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable)。
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
标签页目标的 URL 或路径。
</ResponseField>
Expand Down Expand Up @@ -62,6 +65,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx";
<ResponseField name="hidden" type="boolean">
是否默认隐藏此锚点。
</ResponseField>
<ResponseField name="searchable" type="boolean">
当 `hidden` 为 `true` 时,设置 `searchable: true` 可让下属页面继续出现在搜索、站点地图、`llms.txt` 以及 AI 助手中。请参阅[隐藏页面](/zh/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable)。
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
锚点目标的 URL 或路径。
</ResponseField>
Expand All @@ -79,6 +85,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx";
<ResponseField name="hidden" type="boolean">
是否默认隐藏此下拉菜单。
</ResponseField>
<ResponseField name="searchable" type="boolean">
当 `hidden` 为 `true` 时,设置 `searchable: true` 可让下属页面继续出现在搜索、站点地图、`llms.txt` 以及 AI 助手中。请参阅[隐藏页面](/zh/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable)。
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
下拉菜单目标的 URL 或路径。
</ResponseField>
Expand Down
Loading