# Mintlify: Chinese

> Mintlify is a platform for building and hosting documentation websites. It provides a set of tools and services for maintaining documentation and making it accessible to AI agents.

## Chinese

- [Chinese / 文档 (182 pages)](https://www.mintlify.com/docs/_llms/zh/tab.md): Documentation for Chinese / 文档.

### API 参考文档

#### API 参考

- [简介](https://www.mintlify.com/docs/zh/api/introduction.md): 使用 Mintlify REST API 触发部署、嵌入 AI 助手、导出 Analytics 数据，并以编程方式管理文档。

#### 管理

- [触发部署](https://www.mintlify.com/docs/zh/api/update/trigger.md): 为你的文档项目排队一次部署更新。返回一个状态 ID，用于跟踪更新进度。更新将从你配置的部署用分支触发。
- [获取部署状态](https://www.mintlify.com/docs/zh/api/update/status.md): 通过状态 ID 获取更新状态
- [触发预览部署](https://www.mintlify.com/docs/zh/api/preview/trigger.md): 为特定分支创建或更新预览部署。如果该分支已有预览，则会触发重新部署。返回用于跟踪进度的状态 ID 和预览 URL。
- [触发自动化](https://www.mintlify.com/docs/zh/api/automations/trigger.md): 立即触发计划自动化运行，而无需等待其下一次预定时间。适合从 CI/CD 流水线中运行自动化，例如在每次合并到默认分支时运行的 GitHub Action。仅支持触发计划（自定义计划）自动化。该次运行会处理自上次完成运行以来的变更，与常规计划运行完全相同。

#### Agent

- [创建 Agent 作业](https://www.mintlify.com/docs/zh/api/agent/v2/create-agent-job.md): 创建一个在后台运行的新代理作业。该作业会异步处理提示词——轮询 get job 端点以跟踪进度。如果代理成功编辑文件，则会自动创建拉取请求（PR；亦称“合并请求”/Merge Request）。
- [获取代理任务](https://www.mintlify.com/docs/zh/api/agent/v2/get-agent-job.md): 检索代理作业的当前状态和详细信息。轮询此端点以跟踪作业进度。
- [发送后续消息](https://www.mintlify.com/docs/zh/api/agent/v2/send-message.md): 向现有代理任务发送后续消息。该消息将异步处理——请轮询 get job 端点以跟踪进度。

#### Assistant

- [创建 assistant 消息](https://www.mintlify.com/docs/zh/api/assistant/create-assistant-message-v2.md): 针对指定的 domain，从 AI 助手生成一条回复消息。适用于 AI SDK v5 及更高版本。

#### 搜索

- [搜索文档](https://www.mintlify.com/docs/zh/api/assistant/search.md): 在你的文档中执行语义搜索和关键词搜索，并支持可配置的过滤和分页。
- [获取页面内容](https://www.mintlify.com/docs/zh/api/assistant/get-page-content.md): 通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。

#### Mintlify Index

- [Mintlify Index REST API](https://www.mintlify.com/docs/zh/api/search-index/introduction.md): 使用 Mintlify Index REST API 搜索文档和 Web，组装带有来源引用的上下文，并为应用和代理获取页面内容。
- [构建实现上下文](https://www.mintlify.com/docs/zh/api/search-index/context.md): 搜索 Mintlify Index，并在 token 预算内组装带有来源引用的内容。当应用或代理需要通过一次请求获取可直接使用的上下文时，请使用此端点。
- [搜索技术知识](https://www.mintlify.com/docs/zh/api/search-index/search.md): 返回发布者维护的文档或 Web 中的排名结果。需要更多内容时，请将 Mintlify 结果 ID 或任意结果 URL 与 contents 端点搭配使用。
- [获取结果内容](https://www.mintlify.com/docs/zh/api/search-index/contents.md): 获取搜索端点返回的 Mintlify 结果 ID 或结果 URL 对应的内容。一次请求最多可以在两个字段中包含 20 项。

#### 数据分析

- [获取反馈](https://www.mintlify.com/docs/zh/api/analytics/feedback.md): 返回按页划分的用户反馈，并支持可选筛选条件
- [按页面获取反馈](https://www.mintlify.com/docs/zh/api/analytics/feedback-by-page.md): 按页面获取 Mintlify 文档的用户反馈汇总数据，包括每个页面的赞、踩、代码片段复制次数以及反馈总数。
- [获取 AI 助手会话记录](https://www.mintlify.com/docs/zh/api/analytics/assistant-conversations.md): 返回分页后的 AI 助手会话历史
- [获取 AI 助手会话线程](https://www.mintlify.com/docs/zh/api/analytics/assistant-thread.md): 返回单个 AI 助手会话线程的完整消息转录。线程 ID 可从 AI 助手会话端点获取，或作为 AI 助手链接转接支持 URL 上追加的 `threadId` 查询参数获取。
- [获取 AI 助手调用方统计](https://www.mintlify.com/docs/zh/api/analytics/assistant-caller-stats.md): 返回指定日期范围内按调用方类型（网页端、API 和其他）划分的助手查询次数明细。
- [获取搜索查询](https://www.mintlify.com/docs/zh/api/analytics/searches.md): 导出 Mintlify 文档的搜索查询记录，包含每个搜索词的命中数、点击率以及最近一次被搜索的时间，便于分析用户搜索行为。
- [获取页面浏览量](https://www.mintlify.com/docs/zh/api/analytics/views.md): 获取 Mintlify 文档的页面浏览量统计，按路径细分，并区分来自真实用户与 AI 爬虫或代理的流量来源。
- [获取唯一访客](https://www.mintlify.com/docs/zh/api/analytics/visitors.md): 获取 Mintlify 文档的唯一访客数量，按路径与站点整体统计，并区分真实用户流量与 AI 爬虫或代理产生的访问。

#### 静态导出

- [启动静态导出作业](https://www.mintlify.com/docs/zh/api/static-export/start-job.md): 为部署启动一个静态导出任务。该任务会将你的文档预渲染为一组自包含的静态 HTML、RSC 及资源文件，然后将结果打包为单个可下载的归档文件。
- [获取静态导出作业状态](https://www.mintlify.com/docs/zh/api/static-export/get-job-status.md): 获取静态导出任务的当前状态。启动任务后，可以轮询此端点，直到 `status` 变为 `completed`（或 `failed`）。

### 帮助中心

#### 帮助中心

- [修复 "Failed to fetch OpenAPI file for anchor or tab" 错误](https://www.mintlify.com/docs/zh/help-center/openapi-url-fetch-fails-during-build.md): 解决 Mintlify 构建因私有主机、需要认证的 URL、TLS、DNS 或 CI 竞争条件而无法下载托管的 OpenAPI 文档的问题。
- [修复 "Domain already claimed by another organization" 错误](https://www.mintlify.com/docs/zh/help-center/domain-already-claimed-by-another-organization.md): 从其他 Mintlify 部署释放自定义域名，或在因其他部署或组织占用而无法添加域名时申请支持。
- [使用 Auth0 配置 OAuth 2.0 身份验证](https://www.mintlify.com/docs/zh/help-center/configure-oauth-with-auth0.md): 为私有 Mintlify 文档站点将 Auth0 设置为 OAuth 2.0 身份提供方，包括端点 URL、回调注册和基于用户组的访问控制。
- [创建第二个部署时私有仓库未出现](https://www.mintlify.com/docs/zh/help-center/private-repo-missing-when-creating-second-deployment.md): 重新授权 Mintlify 以获得私有仓库访问权限，使现有的私有 GitHub 仓库出现在新部署的引导仓库选择器中。
- [修复文档站点上返回 404 的静态文件](https://www.mintlify.com/docs/zh/help-center/static-file-not-served.md): 诊断你添加到文档仓库中的文件（例如 JSON、PDF 或图片）为什么无法在 Mintlify 站点上通过预期 URL 加载。
- [未为 fork 分支创建预览部署](https://www.mintlify.com/docs/zh/help-center/preview-deployment-not-created-for-fork-branch.md): 为什么从 fork 打开的拉取请求以及传递给预览 API 的 fork 分支不会生成预览部署，以及维护者如何预览来自 fork 的更改。
- [为 Card 组件内的图标设置样式](https://www.mintlify.com/docs/zh/help-center/style-card-icons-with-custom-css.md): 使用自定义 CSS 和 card-icon 数据属性选择器，为 Card 组件的图标添加背景色、圆角或内边距。
- [我可以重命名我的部署或组织吗？](https://www.mintlify.com/docs/zh/help-center/can-i-rename-my-deployment-or-organization.md): 在控制台中修改部署的项目名称，并了解为什么子域名和组织名称无法重命名，只能通过删除并重新创建来更改。

### 学习

#### 指南

##### 概览

- [指南](https://www.mintlify.com/docs/zh/guides/index.md): 浏览文档最佳实践、内容策略、SEO 优化、可访问性和 docs-as-code 工作流程的实用指南。

##### AI

- [构建应用内助手](https://www.mintlify.com/docs/zh/guides/assistant-embed.md): 构建并嵌入一个应用内文档助手，使用来自你的 Mintlify 文档站点的引用信息回答用户问题。
- [配置 GitHub 应用的自动合并](https://www.mintlify.com/docs/zh/guides/configure-automerge.md): 通过将 Mintlify 机器人添加到仓库规则集的绕过列表，设置 GitHub 工作流以自动合并 Mintlify pull request。
- [使用自动化](https://www.mintlify.com/docs/zh/guides/use-automations.md): 使用 Mintlify 自动化来自动执行周期性的文档维护：选择合适的触发器、撰写有效的指令，并获得一致的 agent 结果。
- [使用 Claude Code 编写文档](https://www.mintlify.com/docs/zh/guides/claude-code.md): 通过 CLAUDE.md 项目说明配置 Claude Code，按照你的风格指南撰写、审阅和更新你的 Mintlify 文档。
- [使用 Codex 编写文档](https://www.mintlify.com/docs/zh/guides/codex.md): 通过项目说明和 MCP 配置 OpenAI Codex CLI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。
- [使用 Cursor 编写文档](https://www.mintlify.com/docs/zh/guides/cursor.md): 使用项目规则配置 Cursor，以编写遵循你的样式指南、组件使用规范和 MDX 约定的 Mintlify 文档。
- [使用 Devin Desktop 编写文档](https://www.mintlify.com/docs/zh/guides/devin-desktop.md): 使用工作区规则配置 Devin Desktop 的 Cascade AI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。
- [GEO 指南：为 AI 搜索和答案引擎优化文档](https://www.mintlify.com/docs/zh/guides/geo.md): 使用 Generative Engine Optimization 技术，为 ChatGPT、Perplexity 和 Google AI Overviews 等 AI 驱动的答案引擎优化你的文档。

##### API 文档

- [将 MDX API 页面迁移到 OpenAPI 导航](https://www.mintlify.com/docs/zh/guides/migrating-from-mdx.md): 迁移到通过 OpenAPI 自动生成、并具有灵活导航结构的文档。

##### 最佳实践

- [如何创建无障碍文档](https://www.mintlify.com/docs/zh/guides/accessibility.md): 遵循 WCAG 指南创建无障碍文档，包括语义化 HTML、键盘导航、替代文本和包容性内容实践。
- [更新日志](https://www.mintlify.com/docs/zh/create/changelogs.md): 创建包含基于日期条目、RSS 订阅支持和订阅者通知功能的产品更新日志，让用户及时了解最新动态。
- [文档内容类型](https://www.mintlify.com/docs/zh/guides/content-types.md): 使用 Diátaxis 框架为每个页面选择合适的文档类型：教程、操作指南、参考和解释。
- [文档内容模板](https://www.mintlify.com/docs/zh/guides/content-templates.md): 复制并修改即用型 MDX 模板，用于在文档中撰写操作指南、教程、概念解释和 API 参考页面。
- [构建自定义页面布局](https://www.mintlify.com/docs/zh/guides/custom-layouts.md): 使用页面模式和组件在 Mintlify 文档中构建自定义落地页、营销页面及其他非标准布局。
- [如何衡量和提升文档质量](https://www.mintlify.com/docs/zh/guides/improving-docs.md): 使用分析数据、用户反馈和内容审计来识别文档中的不足，并改善对用户最重要的页面。
- [如何设置多语言文档](https://www.mintlify.com/docs/zh/guides/internationalization.md): 设置多语言文档，支持基于语言区域的路由、语言切换导航和翻译内容，以覆盖全球用户。
- [如何有效地链接文档页面](https://www.mintlify.com/docs/zh/guides/linking.md): 在文档中创建内部链接、锚点链接和深层链接，并通过重定向和断链检查维护链接完整性。
- [如何长期维护文档](https://www.mintlify.com/docs/zh/guides/maintenance.md): 通过审查计划、责任模型、自动化检查和内容生命周期实践，保持文档的准确性和时效性。
- [如何在文档中使用图片、截图和视频](https://www.mintlify.com/docs/zh/guides/media.md): 了解何时以及如何在文档中使用截图、GIF 和视频，包括格式选择、替代文本和长期维护方面的指导。
- [如何构建文档导航结构](https://www.mintlify.com/docs/zh/guides/navigation.md): 设计文档导航，通过清晰的信息架构、逻辑分组和经过验证的结构，帮助用户找到所需内容。
- [如何改善文档 SEO](https://www.mintlify.com/docs/zh/guides/seo.md): 通过页面标题、关键词研究、内部链接和技术 SEO 技巧，提升文档在搜索引擎中的排名。
- [如何撰写技术文档](https://www.mintlify.com/docs/zh/guides/style-and-tone.md): 撰写清晰、一致的技术文档，包含关于语气、结构、术语和文风的实用指导，适用于开发者文档和产品文档。
- [如何了解你的文档受众](https://www.mintlify.com/docs/zh/guides/understand-your-audience.md): 定义你的文档受众，研究他们的目标和知识水平，并将这些洞察应用到编写帮助他们成功的内容中。

##### Git

- [文档相关的 Git 概念](https://www.mintlify.com/docs/zh/guides/git-concepts.md): 学习用于文档即代码工作流的 Git 版本控制基础知识，包括仓库、branch、commit 和拉取请求协作。
- [使用 branch](https://www.mintlify.com/docs/zh/guides/branches.md): 创建和管理文档 branch，以预览变更、与团队成员协作，并在发布到生产环境之前合并更新。

##### 使用场景

- [创建开发者文档](https://www.mintlify.com/docs/zh/guides/developer-documentation.md): 构建帮助工程师集成你的 API、SDK 和工具的开发者文档，包括快速入门、参考文档和使用指南。
- [创建知识库](https://www.mintlify.com/docs/zh/guides/knowledge-base.md): 在 Mintlify 上托管团队内部知识库，以整合信息、提升搜索效果，并降低维护成本。
- [创建帮助中心](https://www.mintlify.com/docs/zh/guides/help-center.md): 在 Mintlify 上构建自助式帮助中心，帮助客户找到答案，减少支持工单量，并随团队规模扩展。
- [无头文档与自定义前端](https://www.mintlify.com/docs/zh/guides/custom-frontend.md): 使用 Astro 构建无头文档前端，同时借助 Mintlify 进行内容管理、AI 搜索和助手功能。
- [静态导出](https://www.mintlify.com/docs/zh/api/static-export/overview.md): 通过 Mintlify REST API 生成自包含的文档静态导出，并以单个包的形式下载，用于自托管。

## OpenAPI Specs

- [openapi](/docs/zh/openapi.json)
- [admin-openapi](/docs/zh/admin-openapi.json)
- [discovery-openapi](/docs/zh/discovery-openapi.json)
- [index-openapi](/docs/zh/index-openapi.json)
- [analytics.openapi](/docs/zh/analytics.openapi.json)
- [static-export-openapi](/docs/zh/static-export-openapi.json)

## Optional

- [学习](https://learn.mintlify.com/): 自定进度的课程，帮助你充分利用 Mintlify。