mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
017d7c7377
* fix: reduce Vale false positives via vocab and config updates - Make English-word vocab entries case-insensitive so sentence-start capitalization and normal prose usage stop flagging (agents, rest, cursor, setup, endpoints, etc.) - Add vocab entries for filenames and code identifiers that appear in frontmatter and JSX contexts (docs.json, llms.txt, CLAUDE.md, etc.) - Ignore openapi frontmatter lines, filenames, JSX attributes, email addresses, and internal link targets via TokenIgnores - Skip inline code scope and indented code fences - Add Headings exceptions for proper nouns (Claude Code, GitHub Actions, Route 53, GA4, etc.) - Disable linting for the all-code vercel-json-generator snippet Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: resolve all Vale warnings and errors across docs Content fixes: - Reword sentences using 'will', first person, spaced em dashes, 'e.g.', Latin abbreviations, and hyphenated adverbs - Sentence-case headings that started with dotted filenames - Backtick literal API values instead of bolding them - Move periods inside quotation marks - Fix Oxford comma rule misfires by restructuring sentences False-positive suppression: - Vale toggles around example user questions, keyboard shortcut keys (Cmd+I), UI labels, and code samples in JSX contexts that Vale misparses - Exclude vale toggle comments from the brace Token/BlockIgnores so in-document commands actually reach Vale (the greedy brace pattern was also silently swallowing large regions; now lazy) - Vocab entries for code identifiers (internal_id, handleSubmit, etc.) - Per-file rule disables for component docs with dotted JSX names and files where link-target linting ignores in-document toggles Result: vale --minAlertLevel warning is clean repo-wide; only suggestion-level items (Passive, Semicolons, Acronyms) remain. mint broken-links passes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: correct WordList rule instead of degrading prose - Restore sentence-start "Email" in advanced-support; the rule now only flags hyphenated e-mail/E-mail forms - Restore the idiom "above all else"; the above->preceding swap now exempts "above all" Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: restore deliberate prose flagged by blunt rules - Restore spatial 'above the navbar' / 'above a page title' in custom-scripts; the above->preceding swap now exempts 'above the/a/an' - Restore the '= ...' in the react-components named-export example (the ellipsis is inside inline code) with an Ellipses toggle - Restore SLA phrasing 'will use commercially reasonable efforts' with a Will toggle - Restore the quoted developer question in the GEO guide intro with a FirstPerson toggle, matching the file's other example questions Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: remove WordList swaps that flag legitimate English - Drop tablet->device and firewalls->firewall rules; both words are correct in ordinary prose - Narrow touch->tap to UI-instruction phrasing (touch the/a) so 'keep in touch' and 'touch devices' stop flagging Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: reposition vale toggles to wrap whole blocks Toggle comments placed between list items split the lists (restarting ol numbering in deployments) and comments flush against tables risked breaking GFM table parsing. Wrap entire lists/tables with blank-line separation instead. Verified rendering with mint dev: single ol with two items, tables intact, no comments in visible DOM. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * refactor: prune accept.txt to load-bearing entries Empirically removed 166 vocab entries (575 -> 409) whose removal causes no Vale flags across all 908 English pages: dictionary words that never needed listing (agents, setup, endpoints, webhooks, yaml), lowercase entries the speller already accepts, and filename entries made redundant by inline vale toggles. Kept every case-enforcing entry (API, JSON, GitHub, ...) so casing policy is unchanged, plus entries that double as capitalization exceptions for headings (mcp, md, auth, cursor, txt). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Update ai/mintlify-mcp.mdx * Update api/agent/v2/create-agent-job.mdx * chore: alphabetize Headings exceptions and accept.txt Case-insensitive sort, ignoring the (?i) prefix; also drops a duplicate Scala entry. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: re-apply OxfordComma rewrite lost in branch merge Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve Vale suggestions batch 1 (acronyms, semicolons, passive voice) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve remaining Vale suggestions (passive voice batch 2) Rewrite ~90 passive constructions to active voice across deploy, guides, migration-services, and organize docs. Toggle the deliberate passive examples in the style-and-tone guide ('by zombies' test). Add axios/lodash vocab entries for a repositioned code example. vale . is now fully clean: 0 errors, 0 warnings, 0 suggestions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
164 lines
6.5 KiB
Plaintext
164 lines
6.5 KiB
Plaintext
---
|
|
title: "Hidden pages"
|
|
description: "Hide documentation pages from the sidebar navigation while keeping them accessible via direct URL, search, or AI assistant for special use cases."
|
|
keywords: ["hide from navigation", "unlisted", "page visibility"]
|
|
---
|
|
|
|
Hidden pages don't appear in your site's navigation, but anyone who knows the URL can still access them. For example, if you create a hidden page like `guides/hidden-page.mdx`, visitors can reach it at `docs.yoursite.com/guides/hidden-page`.
|
|
|
|
Use hidden pages for content you want users to access or reference as context for AI tools, but don't want listed in the navigation.
|
|
|
|
<Warning>
|
|
Hidden pages are not private. Anyone with the URL can view them, and links shared externally still work. Hiding a page only removes it from the rendered navigation.
|
|
|
|
If your content requires strict access control, you must configure [authentication](/deploy/authentication-setup). To restrict pages to specific user groups, set up [group-based access control](/deploy/authentication-setup#control-access-with-groups).
|
|
</Warning>
|
|
|
|
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>
|
|
|
|
## Hide a page
|
|
|
|
To hide a page, set `hidden: true` in the page's [frontmatter](/organize/pages) or remove it from your `docs.json` navigation.
|
|
|
|
### Set `hidden: true` in frontmatter
|
|
|
|
Add `hidden: true` to a page's frontmatter to remove it from the rendered navigation while still including it in your `docs.json` configuration.
|
|
|
|
```yaml
|
|
---
|
|
title: "My hidden page"
|
|
hidden: true
|
|
---
|
|
```
|
|
|
|
To make a page visible again, remove the `hidden` field entirely. Do not set `hidden: false` as it results in undefined behavior.
|
|
|
|
<Note>
|
|
By default, `hidden: true` excludes a page from search engine indexing, sitemaps, and AI context.
|
|
|
|
To include it anyway, set `seo.indexing: "all"` in `docs.json`. See [Search, SEO, and AI indexing](#search-seo-and-ai-indexing) for details.
|
|
|
|
`noindex: true` only affects indexing—it does not hide the page from navigation. See [Disable indexing](/optimize/seo#disable-indexing) for more information.
|
|
</Note>
|
|
|
|
### Remove the page from navigation
|
|
|
|
If you don't include a page in your `docs.json` navigation, you hide it. This method works well for pages that you don't want to appear in navigation at all.
|
|
|
|
## Hide a group of pages
|
|
|
|
To hide a group of pages, set the `hidden` property to `true` for the group 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 stays hidden and the `Guides` group remains visible.
|
|
|
|
### Hide a tab
|
|
|
|
To hide a tab, add the `hidden` property for the tab in your `docs.json` file:
|
|
|
|
```json highlight={4}
|
|
"tabs": [
|
|
{
|
|
"tab": "Home",
|
|
"hidden": true,
|
|
"pages": [
|
|
"index",
|
|
"quickstart"
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
## 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. You have two ways to include hidden content in search and indexing.
|
|
|
|
The following table summarizes how each property affects page visibility and indexing:
|
|
|
|
| Property | Sidebar navigation | Site search | Sitemap | Search engine indexing | AI assistant context |
|
|
|---|---|---|---|---|---|
|
|
| `hidden: true` | Hidden | Excluded | Excluded | Excluded | Excluded |
|
|
| `noindex: true` | Visible | Excluded | Excluded | Excluded | Excluded |
|
|
| `searchable: false` (page frontmatter) | Visible | Excluded | Included | Included | Excluded |
|
|
| `searchable: true` (on hidden tab/group) | Hidden | Included | Included | Included | Included |
|
|
| `seo.indexing: "all"` (in `docs.json`) | Hidden | Included | Included | Included | Included |
|
|
|
|
### Include all hidden pages
|
|
|
|
To include every hidden page across your site in search, sitemaps, and AI context, add the `seo` property to your `docs.json`:
|
|
|
|
```json
|
|
"seo": {
|
|
"indexing": "all"
|
|
}
|
|
```
|
|
|
|
### Include pages under specific hidden tabs or groups
|
|
|
|
To include only the pages under a specific hidden tab or group, set `searchable: true` on that tab or group in your `docs.json`. Use this option when you hide tabs or groups to control navigation layout but still want descendant pages discoverable.
|
|
|
|
```json highlight={5}
|
|
"tabs": [
|
|
{
|
|
"tab": "Storage",
|
|
"hidden": true,
|
|
"searchable": true,
|
|
"groups": [
|
|
{
|
|
"group": "Buckets",
|
|
"pages": ["products/storage/buckets/create-bucket"]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
With `searchable: true`, descendant pages remain in:
|
|
|
|
- Documentation site search
|
|
- `sitemap.xml`
|
|
- AI assistant context
|
|
- MCP server search results
|
|
- Search engine indexing (the `noindex` meta tag is not applied)
|
|
|
|
The tab or group itself stays hidden from the rendered navigation.
|
|
|
|
A page's own `hidden: true` frontmatter always takes precedence. To re-exclude a descendant group, set `hidden: true` on it without `searchable: true`.
|
|
|
|
### Page-level `searchable`
|
|
|
|
At the page frontmatter level, `searchable` only accepts `false`. Use it to keep a page indexable by external search engines while excluding it from in-product search and AI assistant context. See [Exclude a page from search](/optimize/search#exclude-a-page-from-search) for an example.
|
|
|
|
Page-level `searchable` does not override `hidden: true` on the same page. To make a hidden page discoverable, leave `searchable` unset and either move it under a hidden tab or group with `searchable: true`, or set `seo.indexing: "all"` in `docs.json`.
|
|
|
|
### Understanding hidden versus noindex
|
|
|
|
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 don't appear in site search, sitemaps, search engine indexing, or AI assistant context.
|
|
|
|
To exclude a specific page from search and indexing while keeping it visible in navigation, add `noindex: true` to its frontmatter. To hide a page from navigation as well, use `hidden: true`. To exclude a page only from your in-product search and AI assistant context while keeping it indexable by external search engines, use [`searchable: false`](/optimize/search#exclude-a-page-from-search) instead. |