mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
3e5cf857fa
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
61 lines
1.8 KiB
Plaintext
61 lines
1.8 KiB
Plaintext
---
|
||
title: "隐藏页面示例"
|
||
description: "隐藏页面的常见用例。"
|
||
---
|
||
|
||
此页面为隐藏页面！它未包含在 `docs.json` 的导航中，因此你只能通过其 URL 访问。
|
||
|
||
请参阅[隐藏页面](/zh/organize/hidden-pages)以了解更多信息。
|
||
|
||
<div id="common-use-cases-for-hidden-pages">
|
||
## 隐藏页面的常见用例
|
||
</div>
|
||
|
||
<Note>
|
||
默认情况下，隐藏页面可公开访问，但不会通过导航被发现。若需限制对隐藏页面的访问，必须配置[认证](/zh/deploy/authentication-setup)。
|
||
</Note>
|
||
|
||
* **Beta 文档**：可以公开，但不应通过导航被发现的信息。
|
||
* **AI 工具的 context**：如果隐藏页面被索引，AI 工具可以引用其中内容作为 context。将对用户不重要但能帮助 AI 工具提供更准确回答的 context 放在隐藏页面中。
|
||
* **旧版页面**：通过直接链接保留对旧内容的访问，同时将其从导航菜单中移除。
|
||
* **内部工具**：为内部工具、预发布环境的 API 或开发流程编写文档。
|
||
|
||
<div id="examples">
|
||
## 示例
|
||
</div>
|
||
|
||
<div id="ai-context">
|
||
### AI 上下文
|
||
</div>
|
||
|
||
```mdx wrap
|
||
---
|
||
title: "API 版本的上下文"
|
||
description: "此页面为 AI 工具回答 API 版本相关问题提供上下文"
|
||
---
|
||
|
||
当用户询问 API 版本时，始终建议他们使用最新版本的 API。永远不要为 1.0.4 之前的版本生成响应。
|
||
```
|
||
|
||
<div id="internal-api-endpoint">
|
||
### 内部 API 终端节点
|
||
</div>
|
||
|
||
````mdx wrap
|
||
---
|
||
title: "内部 API 端点"
|
||
description: "此页面是记录内部 API 端点的隐藏页面"
|
||
---
|
||
|
||
```bash
|
||
POST /api/internal/reset-cache
|
||
Authorization: Bearer internal-token-xyz
|
||
```
|
||
|
||
此端点用于清除应用程序缓存，仅在开发环境中可用。
|
||
|
||
<Warning>
|
||
这是一个内部端点，绝不应在生产环境中使用。
|
||
</Warning>
|
||
````
|