diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx index a03592202..18adab382 100644 --- a/guides/hidden-pages.mdx +++ b/guides/hidden-pages.mdx @@ -24,6 +24,48 @@ See an [example of a hidden page](/guides/hidden-page-example). Some navigation elements like sidebars, dropdowns, and tabs may appear empty or shift layout on hidden pages. +## Hiding a group of pages + +A group of pages is hidden if the `hidden` property is set to `true` in your `docs.json` file: + +```json highlight={4} +"groups": [ + { + "group": "Getting started", + "hidden": true, + "pages": [ + "index", + "quickstart" + ] + }, + { + "group": "Guides", + "pages": [ + "guides/hidden-page.mdx", + "guides/hidden-groups.mdx" + ] + } +] +``` +In this example, the `Getting started` group is hidden, but the `Guides` group is visible. + +### Hiding a tab + +You can also hide a tab by adding the `hidden` property to your `docs.json` file: + +```json highlight={4} +"tabs": [ + { + "tab": "Home", + "hidden": true, + "pages": [ + "index", + "quickstart" + ] + } +] +``` + ## Search, SEO, and AI indexing By default, hidden pages are excluded from indexing for search engines, internal search within your docs, and as context for the AI assistant. To include hidden pages in search results and as context for the assistant, add the `seo` property to your `docs.json`: