mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
76228fcf88
* Update deploy/authentication-setup.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update deploy/authentication-setup.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update deploy/authentication-setup.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * remove personalization pages * update links to personalization * fix TODO:s * use wildcard redirects * vale --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
79 lines
2.3 KiB
Plaintext
79 lines
2.3 KiB
Plaintext
---
|
|
title: "Hidden pages"
|
|
description: "Hide pages from your navigation while keeping them accessible."
|
|
keywords: ["hide from navigation", "unlisted", "page visibility"]
|
|
---
|
|
|
|
Hidden pages are not included in your site's navigation but remain publicly accessible to anyone who knows their URL.
|
|
|
|
Use hidden pages for content that you want to be accessible on your site or referenced as context for AI tools, but not discoverable through the navigation.
|
|
|
|
For content requiring strict access control, you must configure [authentication](/deploy/authentication-setup).
|
|
|
|
To restrict pages to specific groups of users, configure [group-based access control](/deploy/authentication-setup#control-access-with-groups).
|
|
|
|
## Hiding a page
|
|
|
|
To hide a page, remove it from your navigation structure. Any pages that are not included in your `docs.json` navigation are hidden.
|
|
|
|
Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`.
|
|
|
|
See an [example of a hidden page](/organize/hidden-page-example).
|
|
|
|
<Note>
|
|
Some navigation elements like sidebars, dropdowns, and tabs may appear empty or shift layout on hidden pages.
|
|
</Note>
|
|
|
|
## 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`:
|
|
|
|
```json
|
|
"seo": {
|
|
"indexing": "all"
|
|
}
|
|
```
|
|
|
|
To exclude a specific page, add `noindex: true` to its frontmatter. |