diff --git a/es/organize/hidden-pages.mdx b/es/organize/hidden-pages.mdx index cf8c8665e..200947822 100644 --- a/es/organize/hidden-pages.mdx +++ b/es/organize/hidden-pages.mdx @@ -100,6 +100,46 @@ Para ocultar una Tab, añade la propiedad `hidden` para la Tab en tu archivo `do ] ``` +
+ ## Mantener páginas ocultas detectables con `searchable` +
+ +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 ``, 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. + + + `searchable: true` solo tiene efecto cuando también se establece `hidden: true`. En un elemento visible no hace nada. + +
## Búsqueda, SEO e indexación de IA
diff --git a/es/organize/settings-structure.mdx b/es/organize/settings-structure.mdx index d4768d2ab..2a1f8709c 100644 --- a/es/organize/settings-structure.mdx +++ b/es/organize/settings-structure.mdx @@ -33,6 +33,9 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp Si se debe ocultar esta pestaña de forma predeterminada. + + 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). + URL o ruta para el destino de la pestaña. @@ -62,6 +65,9 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp Si se debe ocultar este ancla de forma predeterminada. + + 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). + URL o ruta para el destino del ancla. @@ -79,6 +85,9 @@ Consulta [Navegación](/es/organize/navigation) para obtener documentación comp Si se debe ocultar este desplegable de forma predeterminada. + + 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). + URL o ruta para el destino del desplegable. diff --git a/fr/organize/hidden-pages.mdx b/fr/organize/hidden-pages.mdx index beba02945..850cf0fc6 100644 --- a/fr/organize/hidden-pages.mdx +++ b/fr/organize/hidden-pages.mdx @@ -100,6 +100,46 @@ Pour masquer un onglet, ajoutez la propriété `hidden` pour l’onglet dans vot ] ``` +
+ ## Garder les pages masquées détectables avec `searchable` +
+ +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 ``, 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. + + + `searchable: true` n’a d’effet que si `hidden: true` est également défini. Sur un élément visible, il n’a aucun effet. + +
## Recherche, SEO et indexation par l’IA
diff --git a/fr/organize/settings-structure.mdx b/fr/organize/settings-structure.mdx index 458e83039..a3a31a5d5 100644 --- a/fr/organize/settings-structure.mdx +++ b/fr/organize/settings-structure.mdx @@ -33,6 +33,9 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l Indique s'il faut masquer cet onglet par défaut. + + 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). + URL ou chemin de destination de l'onglet. @@ -62,6 +65,9 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l Indique s'il faut masquer cette ancre par défaut. + + 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). + URL ou chemin de destination de l'ancre. @@ -79,6 +85,9 @@ Voir [Navigation](/fr/organize/navigation) pour la documentation complète sur l Indique s'il faut masquer ce menu déroulant par défaut. + + 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). + URL ou chemin de destination du menu déroulant. diff --git a/organize/hidden-pages.mdx b/organize/hidden-pages.mdx index 3d2284cfd..8f35572e7 100644 --- a/organize/hidden-pages.mdx +++ b/organize/hidden-pages.mdx @@ -90,6 +90,44 @@ To hide a tab, add the `hidden` property for the tab in your `docs.json` file: ] ``` +## 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. +- Rendered HTML does not include ``, 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. + + + `searchable: true` only has an effect when `hidden: true` is also set. On a visible element it does nothing. + + ## 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`: diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx index 699fdfec0..bde593a7e 100644 --- a/organize/settings-structure.mdx +++ b/organize/settings-structure.mdx @@ -33,6 +33,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Whether to hide this tab by default. + + 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). + URL or path for the tab destination. @@ -62,6 +65,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Whether to hide this anchor by default. + + 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). + URL or path for the anchor destination. @@ -79,6 +85,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Whether to hide this dropdown by default. + + 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). + URL or path for the dropdown destination. diff --git a/zh/organize/hidden-pages.mdx b/zh/organize/hidden-pages.mdx index df4a4167c..62cfae2bf 100644 --- a/zh/organize/hidden-pages.mdx +++ b/zh/organize/hidden-pages.mdx @@ -100,6 +100,46 @@ hidden: true ] ``` +
+ ## 使用 `searchable` 让隐藏页面仍可被发现 +
+ +默认情况下，隐藏一个标签页、分组、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 不会包含 ``，因此搜索引擎可以索引这些页面。 +- 标签页、分组、anchor 或 dropdown 本身仍不会出现在侧边栏导航中。 + +你可以在任何支持 `hidden` 的导航元素上设置 `searchable: true`，包括标签页、分组、anchor 和 dropdown。通过 `searchable` 启用的页面仍可通过直接 URL 访问。 + + + 只有同时设置 `hidden: true` 时，`searchable: true` 才会生效。对可见元素设置它不会产生任何作用。 + +
## 搜索、SEO 与 AI 索引编入
diff --git a/zh/organize/settings-structure.mdx b/zh/organize/settings-structure.mdx index b5e678479..69ef8b89f 100644 --- a/zh/organize/settings-structure.mdx +++ b/zh/organize/settings-structure.mdx @@ -33,6 +33,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 是否默认隐藏此标签页。 + + 当 `hidden` 为 `true` 时，设置 `searchable: true` 可让下属页面继续出现在搜索、站点地图、`llms.txt` 以及 AI 助手中。请参阅[隐藏页面](/zh/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable)。 + 标签页目标的 URL 或路径。 @@ -62,6 +65,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 是否默认隐藏此锚点。 + + 当 `hidden` 为 `true` 时，设置 `searchable: true` 可让下属页面继续出现在搜索、站点地图、`llms.txt` 以及 AI 助手中。请参阅[隐藏页面](/zh/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable)。 + 锚点目标的 URL 或路径。 @@ -79,6 +85,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 是否默认隐藏此下拉菜单。 + + 当 `hidden` 为 `true` 时，设置 `searchable: true` 可让下属页面继续出现在搜索、站点地图、`llms.txt` 以及 AI 助手中。请参阅[隐藏页面](/zh/organize/hidden-pages#keep-hidden-pages-discoverable-with-searchable)。 + 下拉菜单目标的 URL 或路径。