隐藏页面会从你站点的导航中移除,但任何知道其 URL 的人仍可公开访问。
当你希望某些内容在站点上可访问,或作为 AI 工具的上下文被引用,但又不希望通过导航被发现时,请使用隐藏页面。
对于需要严格访问控制的内容,必须配置认证。
如果你想仅对特定用户群体隐藏页面,请使用个性化来控制页面可见性。
如果某个页面未包含在你的 docs.json
导航中,则该页面会被隐藏。要隐藏页面,请将其从导航结构中移除。
隐藏页面会根据其文件路径使用与常规页面相同的 URL 结构。例如,guides/hidden-page.mdx
可通过 docs.yoursite.com/guides/hidden-page
访问。
查看隐藏页面示例。
某些导航元素(如侧边栏、下拉菜单和选项卡)在隐藏页面上可能会显示为空或导致布局变化。
在 docs.json
文件中将 hidden
属性设为 true
时,该页面组会被隐藏:
"groups": [
{
"group": "快速开始",
"hidden": true,
"pages": [
"index",
"quickstart"
]
},
{
"group": "指南",
"pages": [
"guides/hidden-page.mdx",
"guides/hidden-groups.mdx"
]
}
]
在此示例中,Getting started
分组被隐藏,而 Guides
分组可见。
你也可以在 docs.json
文件中添加 hidden
属性来隐藏某个标签页:
"tabs": [
{
"tab": "首页",
"hidden": true,
"pages": [
"index",
"quickstart"
]
}
]
默认情况下,隐藏页面不会被编入索引(包括搜索引擎、文档站点内搜索,以及提供给 AI 助手的上下文)。如需将隐藏页面包含在搜索结果中,并作为 AI 助手的上下文使用,请在你的 docs.json
中添加 seo
属性:
"seo": {
"indexing": "all"
}
要排除某个页面,请在其 frontmatter 中添加 noindex: true
。