# 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.

> ## Agent Instructions
> To set up a new Mintlify project for a user, follow the agent setup workflow in https://www.mintlify.com/docs/quickstart.md.
> For plans and pricing, see https://www.mintlify.com/pricing.md.

## Chinese

- [Chinese / 文档 (187 pages)](https://www.mintlify.com/docs/_llms/zh/tab.txt): 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。仅支持触发计划（自定义计划）自动化。该次运行会处理自上次完成运行以来的变更，与常规计划运行完全相同。
- [触发自动化 webhook](https://www.mintlify.com/docs/zh/api/automations/webhook.md): 为一个具有 webhook 触发器的自定义自动化排队一次运行，而不必等待该触发器配置的事件。适用于从 CI/CD 流水线、发布脚本或任何其他已经发送事件的系统运行自动化。只能触发配置了 webhook 触发器的自定义自动化；使用其他触发器的自动化会返回 `404` 响应。

#### Agent

- [获取代理任务](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): 通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。

#### 数据分析

- [获取反馈](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): <Warning>**静态导出未公开提供。** 仅适用于 Enterprise 套餐。请联系 [sales@mintlify.com](mailto:sales@mintlify.com) 申请访问权限。</Warning>
- [获取静态导出作业状态](https://www.mintlify.com/docs/zh/api/static-export/get-job-status.md): <Warning>**静态导出未公开提供。** 仅适用于 Enterprise 套餐。请联系 [sales@mintlify.com](mailto:sales@mintlify.com) 申请访问权限。</Warning>

### 帮助中心

#### 帮助中心

- [我可以重命名我的项目或组织吗？](https://www.mintlify.com/docs/zh/help-center/can-i-rename-my-deployment-or-organization.md): 在控制台中重命名项目或组织，并了解为什么子域名和组织 slug 只能通过删除并重新创建来更改。
- [更改组织图标](https://www.mintlify.com/docs/zh/help-center/change-your-workspace-icon.md): 在 Mintlify 控制台中上传、替换或移除代表你的组织的图标，并了解支持的文件格式和大小限制。
- [默认 mintlify.app 子域名与自定义域名同时被索引](https://www.mintlify.com/docs/zh/help-center/default-subdomain-indexed-alongside-custom-domain.md): 为什么在添加自定义域名后，默认的 <subdomain>.mintlify.app 地址仍可被抓取，以及如何将其从搜索引擎结果中移除。
- [修复 "Domain already claimed by another organization" 错误](https://www.mintlify.com/docs/zh/help-center/domain-already-claimed-by-another-organization.md): 从其他 Mintlify 项目释放自定义域名，或在因其他项目或组织占用而无法添加域名时申请帮助。
- [创建第二个项目时私有仓库未出现](https://www.mintlify.com/docs/zh/help-center/private-repo-missing-when-creating-second-deployment.md): 重新授权 Mintlify 以获得私有仓库访问权限，使现有的私有 GitHub 仓库出现在新项目的引导仓库选择器中。
- [未为 fork 分支创建预览部署](https://www.mintlify.com/docs/zh/help-center/preview-deployment-not-created-for-fork-branch.md): 为什么从 fork 打开的拉取请求以及传递给预览 API 的 fork 分支不会生成预览部署，以及维护者如何预览来自 fork 的更改。
- [用于 Git 提供方允许列表的 Mintlify 静态 IP](https://www.mintlify.com/docs/zh/help-center/ip-addresses-for-git-provider-allowlists.md): 为 GitHub Enterprise Cloud、GHES 与自托管 GitLab 允许 Mintlify 的静态出站 IP 54.242.90.151。
- [agent 被 Git 提供商 IP 允许列表阻止](https://www.mintlify.com/docs/zh/help-center/agent-blocked-by-git-provider-ip-allow-list.md): 通过将项目路由到 Mintlify 静态 IP，解决因 GitHub 或 GitLab IP 允许列表导致的 agent 会话失败。
- [使用 Auth0 配置 OAuth 2.0 身份验证](https://www.mintlify.com/docs/zh/help-center/configure-oauth-with-auth0.md): 为私有 Mintlify 文档站点将 Auth0 设置为 OAuth 2.0 身份提供方，包括端点 URL、回调注册和基于用户组的访问控制。
- [修复 "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 文档的问题。
- [修复文档站点上返回 404 的静态文件](https://www.mintlify.com/docs/zh/help-center/static-file-not-served.md): 诊断你添加到文档仓库中的文件（例如 JSON、PDF 或图片）为什么无法在 Mintlify 站点上通过预期 URL 加载。
- [Web 编辑器分支列表中缺少分支](https://www.mintlify.com/docs/zh/help-center/branch-missing-from-editor-branch-list.md): 为什么仓库中存在的分支没有出现在 Web 编辑器的分支下拉菜单中，以及如何通过搜索找到该分支。
- [Web 编辑器显示 "Repository unavailable"](https://www.mintlify.com/docs/zh/help-center/editor-shows-repository-unavailable.md): 当 Mintlify 无法访问你的文档仓库或部署分支时，Web 编辑器为何会显示 Repository unavailable 提示，以及如何恢复访问。
- [Tailwind 类在编辑器实时预览中不生效](https://www.mintlify.com/docs/zh/help-center/tailwind-classes-not-applying-in-editor-preview.md): Web 编辑器的实时预览会跳过为 Tailwind 类生成 CSS 的构建步骤。请使用 mint dev 或预览部署检查样式。
- [为 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/site-search-returns-no-results.md): 排查文档站点内置搜索对任何查询都不返回结果的原因，通常由 docs.json 中某个版本上的 hidden: true 设置导致。
- [llms.txt 返回 404 的问题](https://www.mintlify.com/docs/zh/help-center/llms-txt-returns-404-but-llms-full-txt-works.md): 排查文档站点 llms.txt 返回 404 而 llms-full.txt 仍可加载的原因，通常由 Don't index project 设置引起。
- [在发现端点中宣告外部托管的 MCP 服务器](https://www.mintlify.com/docs/zh/help-center/register-external-mcp-server-in-discovery.md): 在你的文档域名上与内置搜索 MCP 服务器一同公开自托管的 MCP 服务器，因为 Mintlify 的发现端点仅列出其自身托管的服务器。
- [为什么爬虫过滤后访客数下降了](https://www.mintlify.com/docs/zh/help-center/visitor-count-dropped-after-crawler-filtering.md): 了解为什么 Mintlify 分析中的访客总数在 2026 年 9 月下降:爬虫流量已从访客统计中排除,与页面浏览量的过滤规则保持一致。
- [从 Confluence 迁移到 Mintlify](https://www.mintlify.com/docs/zh/help-center/migrate-from-confluence.md): Mintlify 没有专门的 Confluence 迁移指南。使用手动迁移工作流将导出的 Confluence 内容转换为 Mintlify 项目。
- [从 ZIP 导出迁移文档到 Mintlify](https://www.mintlify.com/docs/zh/help-center/migrate-docs-from-a-zip-export.md): Mintlify 不支持直接上传 ZIP。了解如何将 Document360、ReadMe 或其他平台的 ZIP 导出转换为 Mintlify 项目。
- [代理的 PR 面向你的部署分支打开](https://www.mintlify.com/docs/zh/help-center/agent-opens-pull-requests-against-deploy-branch.md): 为什么 Mintlify 代理和自动化会向你的部署分支打开拉取请求,以及如何将更改发送到其他分支。
- [由于 MDX 无效导致发布按钮被禁用](https://www.mintlify.com/docs/zh/help-center/publish-button-disabled-invalid-mdx.md): 为什么编辑器中的发布按钮会被禁用，并显示 'Fix invalid MDX before publishing' 提示，以及如何找到并修复出错的页面。
- [修复 logo.href 或 navbar.primary.href 的 "Must be a valid url" 错误](https://www.mintlify.com/docs/zh/help-center/docs-json-href-must-be-a-valid-url.md): 解决在 logo.href、navbar.links 或 navbar.primary.href 中使用 /contact 等相对路径时出现的 docs.json 验证错误。
- [修复“frontmatter must be a single endpoint string”部署错误](https://www.mintlify.com/docs/zh/help-center/endpoint-frontmatter-must-be-a-single-string.md): 解决因 openapi、api 或 asyncapi 页面 frontmatter 列出多个端点或使用非字符串值而导致的部署失败。
- [文档站点无法在 iframe 中加载](https://www.mintlify.com/docs/zh/help-center/embed-docs-site-in-iframe.md): 了解为什么你的 Mintlify 文档站点无法在其他域名的 iframe 中加载，以及如何申请允许你的应用来源。
- [自定义组件闪烁或在页面源代码中缺失](https://www.mintlify.com/docs/zh/help-center/custom-components-flash-or-missing-from-page-source.md): Mintlify 中的自定义 React 组件在页面加载后于浏览器中渲染，因此不在初始 HTML 中。对于必须在服务端渲染的内容，请使用内置组件。

### 学习

#### 指南

##### 概览

- [指南](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)
- [analytics.openapi](/docs/zh/analytics.openapi.json)
- [static-export-openapi](/docs/zh/static-export-openapi.json)

## Optional

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