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

## 文档

### 快速入门

- [简介](https://www.mintlify.com/docs/zh/index.md): 邂逅新一代文档体验：AI 原生、开箱即用且美观，为开发者打造。
- [快速入门](https://www.mintlify.com/docs/zh/quickstart.md): 按照快速入门指南部署 Mintlify 文档站点，连接 GitHub 或使用 Web 编辑器，完成首次内容修改，并通过 CLI 预览、验证和发布更新，同时为用户或 AI 智能体配置完整工作流。本文涵盖账号设置、仓库连接、域名访问、本地开发、页面编辑、部署检查和后续自定义步骤，帮助你快速开始维护线上文档。
- [AI 原生文档](https://www.mintlify.com/docs/zh/ai-native.md): 了解 AI 原生功能如何通过助手、agent 和 MCP 服务器提升文档的阅读、创作和发现体验。
- [桌面应用](https://www.mintlify.com/docs/zh/desktop.md): 在 macOS、Windows 或 Linux 上安装 Mintlify 桌面应用，在带有标签页和键盘快捷键的原生窗口中使用控制台和编辑器。

#### CLI

- [Mintlify CLI](https://www.mintlify.com/docs/zh/cli/index.md): 使用 Mintlify CLI 在本地预览文档、实时测试更改，在部署前运行断链、无障碍和构建验证检查，并检查 agent 就绪度、格式化 MDX 文件。
- [安装 CLI](https://www.mintlify.com/docs/zh/cli/install.md): 安装 Mintlify CLI 并配置本地文档开发环境：使用 npm 或 pnpm 全局安装、更新 CLI、在 CI 中运行检查，并排查安装和构建问题。
- [Mintlify MDX 扩展](https://www.mintlify.com/docs/zh/cli/mdx-extension.md): 安装 Mintlify MDX 扩展，在本地编写 MDX 时获得自动补全、内联诊断、悬停文档、可视化编辑器和编辑器内预览。
- [本地预览](https://www.mintlify.com/docs/zh/cli/preview.md): 使用 mint dev 运行 Mintlify 文档站点的本地预览，支持实时重载、全文搜索和 AI 助手。
- [Mintlify CLI 命令参考](https://www.mintlify.com/docs/zh/cli/commands.md): Mintlify CLI 命令与选项参考：mint dev、mint validate、mint broken-links 及全局标志。

#### 迁移到 Mintlify

- [迁移概览](https://www.mintlify.com/docs/zh/migration/index.md): 为将现有文档从 Docusaurus、ReadMe、GitBook、Fern、Document360 或其他平台迁移到 Mintlify 选择合适的迁移路径。
- [从 Docusaurus 迁移](https://www.mintlify.com/docs/zh/migration/docusaurus.md): 将 Docusaurus 文档迁移到 Mintlify，包括 MDX 页面、侧边栏、版本、本地化内容、资源和自定义组件。
- [从 ReadMe 迁移](https://www.mintlify.com/docs/zh/migration/readme.md): 将 ReadMe 指南、API 参考、recipes、自定义页面、版本、可复用内容和资源迁移到 Mintlify。
- [从 GitBook 迁移](https://www.mintlify.com/docs/zh/migration/gitbook.md): 将 GitBook 的 sections、Markdown、导航、可复用内容、variants、资源和 OpenAPI 文档迁移到 Mintlify。
- [从 Fern 迁移](https://www.mintlify.com/docs/zh/migration/fern.md): 将 Fern 的 MDX 内容、docs.yml 导航、products、versions、资源、API 参考和组件迁移到 Mintlify。
- [从 Document360 迁移](https://www.mintlify.com/docs/zh/migration/document360.md): 将 Document360 的工作区、语言、文章、分类、媒体、可复用内容和 API 参考迁移到 Mintlify。
- [从其他平台迁移](https://www.mintlify.com/docs/zh/migration/manual.md): 将文档从任意平台转换为 Mintlify 的页面、导航、组件、API 参考、资源和重定向。

### 创建内容

- [可复用片段](https://www.mintlify.com/docs/zh/create/reusable-snippets.md): 创建带有变量的可复用内容片段，在文档页面间保持一致性并减少 MDX 文件中的重复内容。
- [个性化内容](https://www.mintlify.com/docs/zh/create/personalization.md): 根据已识别访客的数据、用户组成员资格和自定义变量显示个性化内容，为不同受众量身定制文档。
- [CI 检查](https://www.mintlify.com/docs/zh/deploy/ci.md): 在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测、代码检查、语法校验和构建预览。

#### 页面

- [页面](https://www.mintlify.com/docs/zh/organize/pages.md): 使用 MDX 文件顶部的 YAML frontmatter 配置页面标题、描述、侧边栏、图标、标签、搜索与 SEO 元数据，并了解页面布局模式、API 页面、外部链接和时间戳设置。本文完整介绍隐藏、索引、可搜索性、搜索加权、相关页面、访问组和上下文菜单等字段，帮助你为文档页面选择合适的布局与行为。
- [隐藏页面](https://www.mintlify.com/docs/zh/organize/hidden-pages.md): 将文档页面从侧边栏导航中隐藏，同时仍可通过直接 URL、站内搜索或 AI 助手访问，适用于内部参考、AI 上下文等特殊场景。
- [相关页面](https://www.mintlify.com/docs/zh/organize/related-pages.md): 使用自动推荐或在页面 frontmatter 中手动整理的链接，在每个页面底部添加“相关主题”版块。

#### 格式设置

- [文本格式](https://www.mintlify.com/docs/zh/create/text.md): 在 MDX 页面中使用 Markdown 标题、粗体、斜体、链接、引用块和其他内联样式选项格式化文档文本。
- [格式化代码](https://www.mintlify.com/docs/zh/create/code.md): 在文档中格式化代码，支持语法高亮、行号、差异对比、复制按钮和 MDX 中的交互式代码组功能。
- [列表与表格](https://www.mintlify.com/docs/zh/create/list-table.md): 使用 Markdown 表格、有序列表、无序列表、嵌套结构和任务列表复选框在文档中呈现结构化数据。

#### 组件

- [概览](https://www.mintlify.com/docs/zh/components/index.md): 浏览 Mintlify 完整组件库，包含适用于 MDX 页面的布局、强调、API 文档和导航元素组件。
- [折叠面板](https://www.mintlify.com/docs/zh/components/accordions.md): 使用折叠面板组件在文档中显示和隐藏内容区块、组织相关信息，并实现渐进式信息披露。
- [徽章](https://www.mintlify.com/docs/zh/components/badge.md): 使用徽章组件高亮显示状态指示器、版本标签或内联元数据，支持自定义颜色和悬停提示。
- [横幅](https://www.mintlify.com/docs/zh/components/banner.md): 在文档站点顶部添加可关闭的横幅，用于显示重要公告、发行说明或通知。
- [标注框](https://www.mintlify.com/docs/zh/components/callouts.md): 添加 info、note、tip、check、warning、danger 和自定义标注框组件，在文档中突出显示重要信息。
- [卡片](https://www.mintlify.com/docs/zh/components/cards.md): 使用卡片组件以可视化容器的形式展示链接、图标、图片和分组内容，从而组织导航。
- [代码分组](https://www.mintlify.com/docs/zh/components/code-groups.md): 使用 CodeGroup 组件在标签页界面中展示多个代码示例，让读者可以比较不同编程语言的实现方式。
- [颜色](https://www.mintlify.com/docs/zh/components/color.md): 使用颜色组件展示带有十六进制值和点击复制功能的色板，适用于设计系统和品牌规范文档。
- [列](https://www.mintlify.com/docs/zh/components/columns.md): 使用 columns 组件将卡片和其他组件排列在响应式多列网格布局中，支持自定义列数。
- [示例](https://www.mintlify.com/docs/zh/components/examples.md): 在桌面设备右侧边栏面板中展示代码示例，与 API 文档并排显示请求和响应样本。
- [可展开项](https://www.mintlify.com/docs/zh/components/expandables.md): 使用可展开组件在 API 文档中切换嵌套对象属性的显示，展示请求和响应对象的子字段。
- [字段](https://www.mintlify.com/docs/zh/components/fields.md): 使用 ParamField 和 ResponseField 组件，通过类型、默认值和验证规则为 API 请求和响应参数编写文档。
- [Frames](https://www.mintlify.com/docs/zh/components/frames.md): 使用 frame 组件为图片、视频和其他内容添加样式化边框、说明文字和视觉强调效果。
- [GitHub](https://www.mintlify.com/docs/zh/components/github.md): 使用 GitHub 组件在文档中嵌入仓库卡片，实时显示仓库的描述、star 数量和 fork 数量。
- [图标](https://www.mintlify.com/docs/zh/components/icons.md): 使用图标组件将 Font Awesome、Lucide、Tabler、emoji 或自定义来源的图标添加到文档页面，支持尺寸和颜色选项。
- [MDX](https://www.mintlify.com/docs/zh/components/mdx.md): 使用 MDX 组件在 JSX 表达式和条件语句中渲染 Markdown，让标题、代码块和表格像页面其余部分一样正常编译，实现条件化内容展示。
- [Mermaid](https://www.mintlify.com/docs/zh/components/mermaid-diagrams.md): 使用 Mermaid 语法在文档中创建流程图、序列图和其他可视化图表，并自动渲染。
- [Panel](https://www.mintlify.com/docs/zh/components/panel.md): 自定义文档页面右侧面板的内容，用于显示补充信息、示例或导航元素。
- [提示](https://www.mintlify.com/docs/zh/components/prompt.md): 展示预置的 AI 提示，提供一键复制和 Cursor 集成按钮，方便用户在 AI 工具中快速使用。
- [响应字段](https://www.mintlify.com/docs/zh/components/responses.md): 使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。
- [步骤](https://www.mintlify.com/docs/zh/components/steps.md): 使用 steps 组件创建带编号的分步流程，引导用户完成顺序任务、教程和设置工作流。
- [选项卡](https://www.mintlify.com/docs/zh/components/tabs.md): 使用 tab 组件将内容组织成可切换的面板，用于展示不同选项、平台版本或语言示例。
- [磁贴](https://www.mintlify.com/docs/zh/components/tiles.md): 使用 tiles 组件在响应式网格布局中展示带有图片缩略图、标题和描述的视觉预览。
- [工具提示](https://www.mintlify.com/docs/zh/components/tooltips.md): 添加工具提示，在用户悬停在文档中的术语、缩写或技术概念上时显示上下文定义和解释。
- [树](https://www.mintlify.com/docs/zh/components/tree.md): 使用树组件显示带有可折叠节点和路径名语法高亮的层级文件与文件夹结构。
- [Update](https://www.mintlify.com/docs/zh/components/update.md): 使用 update 组件以带日期的结构化时间轴格式展示产品更新、发行说明和更新日志条目。
- [视图](https://www.mintlify.com/docs/zh/components/view.md): 使用 view 组件为不同编程语言、框架或配置方案创建可切换的内容面板。
- [Visibility](https://www.mintlify.com/docs/zh/components/visibility.md): 使用 visibility 组件向人类读者、AI 代理、已登录用户、未登录用户或特定用户组展示不同内容。
- [React](https://www.mintlify.com/docs/zh/customize/react-components.md): 使用 JSX、状态和客户端逻辑，在你的 Mintlify 文档中通过自定义 React 组件构建交互且可复用的元素。
- [第三方库](https://www.mintlify.com/docs/zh/customize/third-party-libraries.md): 将 npm 包中的 React 组件（例如图表和设计系统组件）导入到你的 MDX 页面中。

#### 媒体

- [图片与嵌入](https://www.mintlify.com/docs/zh/create/image-embeds.md): 在 MDX 页面中添加图片、嵌入 YouTube 视频和 iframe，以视觉和互动内容丰富文档。
- [文件](https://www.mintlify.com/docs/zh/create/files.md): 从你的文档仓库提供图片、视频、PDF 和数据文件等静态资产，支持自动优化和 CDN 分发。

#### Web 编辑器

- [编辑器概览](https://www.mintlify.com/docs/zh/editor/index.md): 使用 Mintlify 编辑器在浏览器中创建、编辑和发布内容。支持实时协作和持续的 Git 同步。
- [如何使用编辑器](https://www.mintlify.com/docs/zh/editor/tutorial.md): Mintlify 编辑器的分步演练：创建分支、编辑页面、分享预览部署以供审阅，然后发布你的更改。
- [创建和编辑页面](https://www.mintlify.com/docs/zh/editor/pages.md): 在编辑器中创建页面、编辑内容、添加媒体、组织导航、恢复页面的历史版本，以及管理私有页面。
- [发布更改](https://www.mintlify.com/docs/zh/editor/publish.md): 把编辑器中的更改发布到你的线上站点。分支和保护规则决定了发布时会发生什么。
- [审阅更改](https://www.mintlify.com/docs/zh/editor/review.md): 在更改上线前进行预览、与团队共享、请求审阅，并在编辑器中合并 pull request。
- [在编辑器中协作](https://www.mintlify.com/docs/zh/editor/collaborate.md): 在编辑器中发表评论、以建议的形式提出更改，并与团队成员实时共同编辑页面。
- [使用智能体撰写和编辑](https://www.mintlify.com/docs/zh/editor/agent.md): 使用编辑器内置的 AI 智能体撰写内容、编辑页面、留下评论和建议、搜索站点、上传文件并配置设置。
- [编辑器的 AI 与发布设置](https://www.mintlify.com/docs/zh/editor/settings.md): 配置编辑器外观、AI 说明和发布默认值，以控制 Mintlify 网页编辑器的显示方式，以及它提交和合并更改的方式。
- [键盘快捷键](https://www.mintlify.com/docs/zh/editor/keyboard-shortcuts.md): 查看 Mintlify 网页编辑器的完整键盘快捷键列表，包括文本格式、导航和编辑命令。

### 管理站点

- [导航](https://www.mintlify.com/docs/zh/organize/navigation.md): 在 docs.json 中使用分组、页面、下拉菜单、标签页和锚点配置文档站点导航，构建侧边栏结构。
- [上下文菜单](https://www.mintlify.com/docs/zh/ai/contextual-menu.md): 为你的文档添加上下文菜单，一键集成 ChatGPT、Claude、Perplexity、Google AI Studio、Devin、Devin Desktop 和 MCP 工具。
- [使用自己的模型](https://www.mintlify.com/docs/zh/ai/bring-your-own-model.md): 使用你自己的 LLM 提供商 API 密钥，选择为 Mintlify assistant、agent 和自动化提供支持的模型。
- [重定向](https://www.mintlify.com/docs/zh/create/redirects.md): 在 docs.json 中配置 URL 重定向规则，为已移动、重命名或删除的文档页面保留 SEO 排名，并防止读者遇到失效链接。
- [从发布中排除文件](https://www.mintlify.com/docs/zh/organize/mintignore.md): 使用带有 glob 模式的 .mintignore 文件将特定文件和目录排除在已发布文档之外，语法类似 .gitignore。

#### 全局设置

- [全局设置](https://www.mintlify.com/docs/zh/organize/settings.md): 使用 docs.json 配置你的 Mintlify 文档站点，该文件控制导航、外观和集成。
- [外观与品牌](https://www.mintlify.com/docs/zh/organize/settings-appearance.md): 在 docs.json 中配置主题、颜色、logo、favicon、字体和背景。
- [站点结构](https://www.mintlify.com/docs/zh/organize/settings-structure.md): 在 docs.json 中配置导航栏、页脚、横幅、重定向和其他结构设置。
- [API 设置](https://www.mintlify.com/docs/zh/organize/settings-api.md): 在 docs.json 文件中配置 OpenAPI 和 AsyncAPI 规范、交互式 API 演练场、SDK 代码示例和身份验证设置。
- [集成](https://www.mintlify.com/docs/zh/organize/settings-integrations.md): 通过 docs.json 中的集成配置，将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。
- [SEO 和搜索](https://www.mintlify.com/docs/zh/organize/settings-seo.md): 在 docs.json 中配置 SEO 设置，包括站点描述、搜索引擎索引、meta 标签、搜索栏占位符和页面时间戳。
- [docs.json schema 参考](https://www.mintlify.com/docs/zh/organize/settings-reference.md): 所有 `docs.json` 配置属性的完整参考，包含类型、默认值和描述。

#### 存储库设置

- [Monorepo 设置](https://www.mintlify.com/docs/zh/deploy/monorepo.md): 在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。
- [多仓库项目](https://www.mintlify.com/docs/zh/deploy/multi-repo.md): 将多个 Git 仓库中的文件合并到一个 Mintlify 站点，并为每个源仓库分配独立的 URL 路径。
- [使用 GitHub Actions 合并仓库](https://www.mintlify.com/docs/zh/deploy/multirepo-action.md): 使用 Mintlify 多仓库 GitHub Action，将多个仓库中的文档复制到一个文档仓库，并将它们的导航合并到单个 docs.json 中。

#### 视觉自定义

- [主题](https://www.mintlify.com/docs/zh/customize/themes.md): 选择一个主题，自定义文档的外观样式。
- [字体](https://www.mintlify.com/docs/zh/customize/fonts.md): 使用 Google Fonts 或自托管字体文件，为标题、正文和代码块自定义文档站点的排版样式。
- [自定义脚本](https://www.mintlify.com/docs/zh/customize/custom-scripts.md): 使用 Tailwind CSS、自定义 CSS 和 JavaScript 定制文档站点，加载第三方脚本，并设置 API Playground 服务器变量。
- [使用编码代理进行自定义](https://www.mintlify.com/docs/zh/customize/agent-skill.md): 安装 Mintlify 技能，帮助你的编码代理通过配置、组件 props、CSS、JavaScript 和可复用代码片段来自定义你的站点。
- [自定义 404 页面](https://www.mintlify.com/docs/zh/customize/custom-404-page.md): 自定义文档站点 404 错误页面的标题、描述和外观，以匹配你的品牌风格并引导访客。

#### 分析

- [分析概览](https://www.mintlify.com/docs/zh/analytics/index.md): 使用 Mintlify 分析 dashboard 了解文档的流量、助手使用情况、搜索、参与度和反馈。
- [分析文档流量](https://www.mintlify.com/docs/zh/analytics/traffic.md): 使用流量分析跟踪访客、页面浏览量、引荐来源,以及来自人类和 AI agent 的流量。
- [分析助手对话](https://www.mintlify.com/docs/zh/analytics/assistant.md): 使用助手分析了解对话主题、满意度、使用趋势和文档缺口。
- [分析文档搜索](https://www.mintlify.com/docs/zh/analytics/search.md): 使用搜索分析了解查询趋势、无结果的搜索以及结果点击率。
- [分析用户参与](https://www.mintlify.com/docs/zh/analytics/user-engagements.md): 使用参与度分析解读内容操作、CTA 表现、用户流,以及搜索和助手漏斗。
- [衡量使用 Mintlify 节省的时间和成本](https://www.mintlify.com/docs/zh/analytics/savings.md): 使用分析中的“节省”视图，估算 Agent 和自动化节省的工时，以及助手回答所节省的支持成本。
- [收集来自用户和 AI 智能体的页面反馈](https://www.mintlify.com/docs/zh/optimize/feedback.md): 启用反馈小部件、页面评分、上下文备注、代码片段反应以及智能体反馈，帮助你发现并修复文档中的问题。
- [将分析导出为 CSV](https://www.mintlify.com/docs/zh/analytics/export.md): 将分析类别导出为 CSV,并解读流量和助手导出字段。
- [将分析事件流式传输到 Amazon S3](https://www.mintlify.com/docs/zh/analytics/streaming.md): 配置 Enterprise 分析流式传输,将选定的事件类别从你的 Mintlify 项目近乎实时地发送到 Amazon S3。

#### 部署

- [部署](https://www.mintlify.com/docs/zh/deploy/deployments.md): 在 Mintlify 控制台中管理文档部署，包括查看部署历史、监控构建状态、故障排查以及删除项目。
- [预览部署](https://www.mintlify.com/docs/zh/deploy/preview-deployments.md): 为每个拉取请求获取唯一的预览 URL，让审阅者可以在实时环境中查看文档更改，然后再合并到生产环境。
- [GitHub](https://www.mintlify.com/docs/zh/deploy/github.md): 将你的 GitHub 仓库连接到 Mintlify，实现自动部署、拉取请求预览构建和持续文档同步。
- [GitHub Enterprise Server](https://www.mintlify.com/docs/zh/deploy/ghes.md): 在你的 GitHub Enterprise Server 实例上安装和配置 Mintlify GitHub 应用，实现文档自动部署和同步。
- [GitLab](https://www.mintlify.com/docs/zh/deploy/gitlab.md): 将 GitLab 仓库连接到 Mintlify，实现自动化文档部署、合并请求预览和持续同步。
- [Bitbucket Cloud](https://www.mintlify.com/docs/zh/deploy/bitbucket.md): 将 Bitbucket Cloud 仓库连接到 Mintlify，实现自动化部署、拉取请求预览和持续同步。
- [回滚](https://www.mintlify.com/docs/zh/deploy/rollbacks.md): 在控制台中将你的 Mintlify 在线站点恢复到之前的一次成功构建，无需回退提交或等待重新构建。

#### 托管

- [自定义域名](https://www.mintlify.com/docs/zh/customize/custom-domain.md): 使用 DNS 记录、自动 TLS 证书以及 Mintlify 托管或代理流量路由，将你的站点托管在自己的域名、子域名或子路径下。
- [内容安全策略（CSP）配置](https://www.mintlify.com/docs/zh/deploy/csp-configuration.md): 配置内容安全策略标头，在允许 Mintlify 资源的同时，为反向代理和严格网络策略维护安全性。
- [自托管](https://www.mintlify.com/docs/zh/deploy/self-host.md): 在你自己的云或本地环境中运行 Mintlify，可部署在 AWS 或任何 Kubernetes 平台上，包括 Azure、Google Cloud、Oracle Cloud 和 OpenShift。
- [定制开发者门户](https://www.mintlify.com/docs/zh/deploy/custom-portal.md): 在自托管 Mintlify 之上部署完全定制的开发者门户，由 Mintlify 设计和构建，并通过版本化发布交付。

##### 子路径托管

- [在子路径下托管文档](https://www.mintlify.com/docs/zh/deploy/docs-subpath.md): 使用 Cloudflare Workers、Vercel 重写规则或 nginx 反向代理，将你的 Mintlify 文档托管在主域名的类似 /docs 的子路径下。
- [使用 Cloudflare Workers 在子路径下部署](https://www.mintlify.com/docs/zh/deploy/cloudflare.md): 通过 Cloudflare Workers 将你的 Mintlify 文档部署到域名的子路径，包含分步设置和 DNS 配置说明。
- [使用 AWS Route 53 和 CloudFront 在子路径下部署](https://www.mintlify.com/docs/zh/deploy/route53-cloudfront.md): 通过组合 Route 53 DNS 路由、CloudFront 分发和缓存行为，将你的 Mintlify 文档部署到 AWS 子路径。
- [使用 Vercel 在子路径下部署](https://www.mintlify.com/docs/zh/deploy/vercel.md): 通过 Vercel 重写规则将你的 Mintlify 站点托管在主域名的子路径下，并附有分步的 vercel.json 配置演练。
- [反向代理](https://www.mintlify.com/docs/zh/deploy/reverse-proxy.md): 使用 nginx 或类似工具配置自定义反向代理，在你自己的域名子路径上提供 Mintlify 文档服务。

#### 导出站点

- [离线导出](https://www.mintlify.com/docs/zh/deploy/export.md): 将文档站点导出为包含预渲染页面的 zip 压缩包，用于离线查看和内部分发。
- [导出 PDF](https://www.mintlify.com/docs/zh/optimize/pdf-exports.md): 将整个文档站点导出为带有可导航目录的单个 PDF 文件，便于离线阅读、分享和打印。

#### 身份验证

- [认证设置](https://www.mintlify.com/docs/zh/deploy/authentication-setup.md): 为 Mintlify 文档站点配置用户认证，使用密码、OAuth、JWT 或私有认证控制页面和 API 参考的访问权限，并设置公开页面与用户组访问。
- [单点登录（SSO）](https://www.mintlify.com/docs/zh/dashboard/sso.md): 使用 Okta、Azure AD 和 Google Workspace 等 SAML 或 OIDC 身份提供商设置单点登录，实现安全的团队身份验证。
- [SCIM 预配](https://www.mintlify.com/docs/zh/dashboard/scim.md): 使用 SCIM 从你的身份提供商为控制台成员进行预配和取消预配。
- [会话安全](https://www.mintlify.com/docs/zh/dashboard/session-security.md): 配置仪表盘会话超时、最长会话生命周期以及 IP 允许列表，以实施更严格的身份验证和网络访问策略。

#### 安全

- [Dashboard 访问策略](https://www.mintlify.com/docs/zh/dashboard/network-access.md): 将 Mintlify dashboard 的访问限制为受信任的 IP 地址，并通过空闲超时和最大会话有效期控制 dashboard 会话的有效时长。
- [角色](https://www.mintlify.com/docs/zh/dashboard/roles.md): 为团队成员分配管理员、编辑者或查看者角色，控制 Mintlify 中的访问级别、编辑权限和部署能力。
- [审计日志](https://www.mintlify.com/docs/zh/dashboard/audit-logs.md): 查看审计日志，追踪组织成员执行的操作，包括部署、配置更改和权限更新。
- [安全联系人](https://www.mintlify.com/docs/zh/dashboard/security-contact.md): 为你的组织配置安全联系人邮箱地址，用于接收漏洞报告、安全警报和合规更新。

#### 个人设置

- [个人资料](https://www.mintlify.com/docs/zh/dashboard/profile.md): 在 Mintlify 控制台的个人资料设置中管理你的姓名、控制台起始页、主题和 GitHub 连接。
- [通知](https://www.mintlify.com/docs/zh/dashboard/notifications.md): 选择在 Mintlify 控制台中接收哪些关于评论、建议、自动化运行和页面反馈的电子邮件通知。
- [收件箱](https://www.mintlify.com/docs/zh/dashboard/inbox.md): 在 Mintlify 控制台中的同一位置跟踪需要你关注的评论、提及、建议和页面共享。

### Agent

- [什么是 agent？](https://www.mintlify.com/docs/zh/agent/index.md): 使用 Mintlify agent 自动化文档更新。可通过 Slack 消息、pull request 或 API 调用触发变更。
- [将 agent 添加到 Slack](https://www.mintlify.com/docs/zh/agent/slack.md): 在 Slack 中安装 Mintlify agent，用于询问产品相关问题、根据团队对话创建内容更新，并将知识沉淀到 pull request 中。
- [使用 Autopilot 让文档保持最新](https://www.mintlify.com/docs/zh/autopilot.md): Autopilot 是一个 agent，它会在代码变更合并后打开 pull request，并执行持续维护，从而让内容保持准确和最新。
- [自定义 Agent 行为](https://www.mintlify.com/docs/zh/agent/customize.md): 使用 `AGENTS.md` 配置文件自定义 agent 行为，控制其处理文档任务和遵循约定的方式。
- [编写高效提示词](https://www.mintlify.com/docs/zh/agent/effective-prompts.md): 编写清晰、具体的提示词以从 Mintlify agent 获得更好的结果，包含有效指令示例和常见模式的实用技巧。
- [Mintlify agent 使用场景和示例](https://www.mintlify.com/docs/zh/agent/use-cases.md): 了解如何使用 Mintlify agent 在 Slack、拉取请求和 API 工作流中自动更新文档、生成代码示例、处理反馈、沉淀团队知识，并在产品发布后持续维护内容准确性。覆盖从 Slack 线程迭代提示词，到合并功能变更、生成发布说明和通过 API 创建任务的常见场景，帮助团队选择适合的文档维护方式。

#### 自动化

- [自动化概览](https://www.mintlify.com/docs/zh/automations/index.md): 使用 Mintlify 自动化，自动维护内容：按计划、在仓库推送时或在已连接集成的事件上运行 agent。
- [创建自定义自动化](https://www.mintlify.com/docs/zh/automations/create.md): 创建 Mintlify 自动化，按计划、仓库推送或集成事件运行。添加上下文仓库和自定义 agent 提示词。
- [管理自动化](https://www.mintlify.com/docs/zh/automations/manage.md): 从控制台启用、禁用、触发和删除自动化。配置仓库、计划和集成触发器、上下文仓库及 automerge。
- [用于 agent 和自动化的集成](https://www.mintlify.com/docs/zh/automations/integrations.md): 连接第三方应用，让 Mintlify agent 在 Slack 对话和自动化运行中使用实时上下文，或通过共享集成中的事件触发自定义自动化。
- [预定义自动化](https://www.mintlify.com/docs/zh/automations/reference.md): 所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。
- [自托管 GitLab OAuth](https://www.mintlify.com/docs/zh/deploy/gitlab-self-hosted.md): 通过 OAuth 将自托管的 GitLab 实例连接到 Mintlify，让自动化能够代表你克隆存储库、推送提交和发起合并请求。

### Assistant

- [AI 助手](https://www.mintlify.com/docs/zh/assistant/index.md): 为你的文档站点添加由 AI 驱动的聊天助手，实时回答用户问题、引用文档来源、按需生成代码示例，并支持自定义指令与多模态输入。
- [配置 AI 助手](https://www.mintlify.com/docs/zh/assistant/configure.md): 在 Mintlify 仪表盘中配置 AI 助手：启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。
- [自定义 AI 助手行为](https://www.mintlify.com/docs/zh/assistant/customize.md): 通过在文档中添加包含系统指令的 Assistant.md 文件来自定义 AI 助手，塑造其语气、角色定位、关注领域、回答格式与整体响应行为。
- [嵌入 AI 助手小组件](https://www.mintlify.com/docs/zh/assistant/widget.md): 安装并配置 Mintlify 小组件,在任意网站或 Web 应用中嵌入基于你的内容训练的 AI 助手。
- [添加 assistant skills](https://www.mintlify.com/docs/zh/assistant/skills.md): 编写专家级 Markdown 指南（skills），AI 助手在需要时按需加载，使用你的团队手写、有明确观点的内容来回答用户问题并遵循内部规范。
- [朗读](https://www.mintlify.com/docs/zh/assistant/narration.md): 在文档页面顶部添加 Listen to this page 播放器，让读者收听 AI 朗读音频，播放时高亮当前句子并自动滚动页面，还可调整播放速度。
- [使用 AI 助手](https://www.mintlify.com/docs/zh/assistant/use.md): 通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手，在本地预览环境中测试助手响应、指令与自定义配置的行为。

### 面向 Agent 的内容

- [管理员 Model Context Protocol (MCP) 服务器](https://www.mintlify.com/docs/zh/ai/mintlify-mcp.md): 让 Claude、ChatGPT 和 Cursor 等 AI 工具获得对你的 Mintlify 内容和控制台的写入权限，从而编辑页面、更新设置并提交 PR。
- [Model Context Protocol 服务器](https://www.mintlify.com/docs/zh/ai/model-context-protocol.md): 将 Claude、Cursor、ChatGPT 等 AI 工具连接到托管的搜索 MCP 服务器，让它们能够搜索并检索你站点上的文档内容和 API 端点。
- [llms.txt](https://www.mintlify.com/docs/zh/ai/llmstxt.md): 自动生成 llms.txt 和 llms-full.txt 文件，使 ChatGPT 和 Claude 等 AI 工具能够索引并理解你的文档。
- [skill.md](https://www.mintlify.com/docs/zh/ai/skillmd.md): 通过自动生成的 skill.md 能力文件，让你的文档随时可供 AI 智能体使用，并向其描述产品可用的能力。
- [Markdown 导出](https://www.mintlify.com/docs/zh/ai/markdown-export.md): 将文档页面导出为整洁的 Markdown 格式，用于 AI 工具、LLM 集成和自动化内容处理工作流程。

### 搜索与 SEO

- [配置站内搜索的排名、结果和筛选器](https://www.mintlify.com/docs/zh/optimize/search.md): 配置你的 Mintlify 文档站点上的站内搜索栏：排名加权、每次查询的最大结果数，以及按产品和版本进行的搜索筛选器。
- [SEO（搜索引擎优化）](https://www.mintlify.com/docs/zh/optimize/seo.md): 配置元标签、Open Graph 属性、规范 URL 和页面级 SEO 设置，提升文档在搜索引擎中的排名。

### 编写 API 文档

- [操作台](https://www.mintlify.com/docs/zh/api-playground/overview.md): 让开发者在文档中直接测试 API 端点，交互式演练场可发送真实请求并显示响应结果。
- [故障排查](https://www.mintlify.com/docs/zh/api-playground/troubleshooting.md): 排查 API 演练场配置中的常见问题，包括 OpenAPI 验证错误、缺失的端点和身份验证问题。

#### API 规范

- [OpenAPI 设置](https://www.mintlify.com/docs/zh/api-playground/openapi-setup.md): 从 OpenAPI 3.0、3.1 和 3.2 规范文件生成交互式 API 文档，自动创建端点页面，并支持身份验证、服务器 URL 和 Overlay 配置。
- [AsyncAPI 配置](https://www.mintlify.com/docs/zh/api-playground/asyncapi-setup.md): 使用 AsyncAPI 规范文件设置实时 WebSocket 文档，生成交互式频道和消息参考页面。
- [GraphQL 设置](https://www.mintlify.com/docs/zh/api-playground/graphql-setup.md): 从 schema 定义文件为你的 GraphQL API 生成参考页面，包含相互链接的类型以及示例 query、mutation 和响应。

##### SDK 参考设置

- [SDK 参考设置](https://www.mintlify.com/docs/zh/api-playground/sdk-reference-setup.md): 了解如何使用 TypeDoc、DocFX、Javadoc、Sphinx 或 phpDocumentor 的构建产物，在 Mintlify 中自动生成 SDK 参考页面、导航分组、跨页链接和搜索索引，并通过 CI 或远程源保持内容更新。本文还介绍格式配置、目录路径、远程压缩包和仓库组织方式。
- [添加 SDK 示例](https://www.mintlify.com/docs/zh/api-playground/adding-sdk-examples.md): 使用 x-codeSamples OpenAPI 扩展为你的 API 文档添加 SDK 代码示例，或通过 Speakeasy 自动添加。

#### 端点页面

- [复杂数据类型](https://www.mintlify.com/docs/zh/api-playground/complex-data-types.md): 使用 oneOf、anyOf 和 allOf 关键字描述具有灵活 schema 的 API，支持可选属性、多态性和多种数据格式。
- [多种响应](https://www.mintlify.com/docs/zh/api-playground/multiple-responses.md): 为 API 端点记录多种响应变体，包括成功和错误情况，并附带状态码和示例 payload。
- [管理页面可见性](https://www.mintlify.com/docs/zh/api-playground/managing-page-visibility.md): 通过隐藏、过滤或整理自动生成的 OpenAPI 页面，控制哪些 API 端点出现在文档导航中。
- [手动创建 API 文档页面](https://www.mintlify.com/docs/zh/api-playground/mdx-setup.md): 当你需要完全控制布局时，使用 MDX 文件手动创建 API 参考页面，适用于小型 API、原型开发或自定义文档。

### 集成

#### Analytics

- [Analytics 集成](https://www.mintlify.com/docs/zh/integrations/analytics/overview.md): 将 Mintlify 文档连接到 Google Analytics、Mixpanel、PostHog 等分析平台，追踪访客参与情况。
- [Adobe Analytics](https://www.mintlify.com/docs/zh/integrations/analytics/adobe.md): 使用 Adobe Experience Platform Launch 标签将 Adobe Analytics 集成到你的 Mintlify 文档站点，实现详细的使用情况跟踪。
- [Amplitude](https://www.mintlify.com/docs/zh/integrations/analytics/amplitude.md): 将 Amplitude Analytics 集成到你的 Mintlify 文档站点，以跟踪用户行为、页面浏览量和内容参与指标。
- [Clarity](https://www.mintlify.com/docs/zh/integrations/analytics/clarity.md): 将 Microsoft Clarity 集成到你的 Mintlify 文档站点，以捕获会话录制、热图和用户交互分析。
- [Clearbit](https://www.mintlify.com/docs/zh/integrations/analytics/clearbit.md): 将 Clearbit 与你的 Mintlify 文档集成，丰富访客数据、识别访问企业并追踪企业级互动。
- [Fathom](https://www.mintlify.com/docs/zh/integrations/analytics/fathom.md): 将 Fathom Analytics 集成到你的 Mintlify 文档，通过简单的站点 ID 配置实现符合 GDPR、注重隐私的访客跟踪。
- [Google Analytics 4](https://www.mintlify.com/docs/zh/integrations/analytics/google-analytics.md): 将 Google Analytics 4 集成到你的 Mintlify 文档，通过 GA4 ID 跟踪访客行为、页面浏览量和内容参与情况。
- [Google Tag Manager](https://www.mintlify.com/docs/zh/integrations/analytics/google-tag-manager.md): 将 Google Tag Manager 集成到你的 Mintlify 文档，集中管理分析标签、转化跟踪和营销事件。
- [Heap](https://www.mintlify.com/docs/zh/integrations/analytics/heap.md): 将 Heap 分析集成到 Mintlify 文档站点，自动捕获用户交互和事件，进行行为分析。
- [Hightouch](https://www.mintlify.com/docs/zh/integrations/analytics/hightouch.md): 将 Hightouch 集成到你的 Mintlify 文档，同步分析数据以实现受众激活、分群和下游工具路由。
- [Hotjar](https://www.mintlify.com/docs/zh/integrations/analytics/hotjar.md): 将 Hotjar 集成到你的 Mintlify 文档站点，捕获会话录制、热图和用户反馈，获取体验洞察。
- [LogRocket](https://www.mintlify.com/docs/zh/integrations/analytics/logrocket.md): 将 LogRocket 集成到你的 Mintlify 文档，回放用户会话、监控前端错误，并详细调试交互问题。
- [Mixpanel](https://www.mintlify.com/docs/zh/integrations/analytics/mixpanel.md): 将 Mixpanel 集成到你的 Mintlify 文档站点，以跟踪产品分析、用户行为漏斗和内容参与事件。
- [Pirsch](https://www.mintlify.com/docs/zh/integrations/analytics/pirsch.md): 将 Pirsch 集成到你的 Mintlify 文档，实现符合 GDPR 的无 Cookie 分析跟踪，不收集个人数据。
- [Plausible](https://www.mintlify.com/docs/zh/integrations/analytics/plausible.md): 将 Plausible Analytics 集成到你的 Mintlify 文档，实现轻量级、尊重隐私的访客跟踪，无需 Cookie 或同意横幅。
- [PostHog](https://www.mintlify.com/docs/zh/integrations/analytics/posthog.md): 将 PostHog 集成到你的 Mintlify 文档站点，使用 API 密钥跟踪产品分析、功能使用情况和用户行为。
- [Segment](https://www.mintlify.com/docs/zh/integrations/analytics/segment.md): 将 Segment 集成到你的 Mintlify 文档，将分析事件路由到数据仓库、CRM 和营销平台等下游工具。

#### 支持

- [支持平台集成](https://www.mintlify.com/docs/zh/integrations/support/overview.md): 将你的 Mintlify 文档连接到 Intercom 和 Front 等支持平台，让访客可以直接从文档页面获得实时帮助。
- [Intercom](https://www.mintlify.com/docs/zh/integrations/support/intercom.md): 将 Intercom 聊天小部件集成到你的 Mintlify 文档站点，提供实时客户消息、支持和引导帮助。
- [Front](https://www.mintlify.com/docs/zh/integrations/support/front.md): 将 Front 聊天集成到你的 Mintlify 文档站点，让访客可以直接从文档页面发起客户支持会话。

#### 隐私

- [隐私集成](https://www.mintlify.com/docs/zh/integrations/privacy/overview.md): 将你的 Mintlify 文档站点连接到 Osano、Transcend 等隐私平台，管理 Cookie 同意、合规横幅和用户偏好设置。
- [Osano](https://www.mintlify.com/docs/zh/integrations/privacy/osano.md): 将 Osano 集成到你的 Mintlify 文档站点，管理 Cookie 同意横幅、隐私偏好设置和监管合规要求。
- [Transcend](https://www.mintlify.com/docs/zh/integrations/privacy/transcend.md): 将 Transcend 同意管理与你的 Mintlify 文档集成，使用你现有的 Transcend bundle 在获得访客同意后再加载分析。

### 参考

- [核心概念](https://www.mintlify.com/docs/zh/reference/concepts.md): 了解 Mintlify 如何连接你的组织、文档存储库、编辑工作流、部署以及 AI 功能。
- [术语表](https://www.mintlify.com/docs/zh/reference/glossary.md): 查找 Mintlify 产品、内容、导航、部署、Git、API 和 AI 相关术语的定义。
- [积分定价](https://www.mintlify.com/docs/zh/credits.md): 了解每项 AI 操作的固定积分价格、共享积分余额如何运作，以及 Mintlify 如何对套餐、超额使用和结转进行计费。