跳转到主要内容
install.md 文件为 Claude Code、Cursor 和 ChatGPT 等 AI agent 提供以任务为导向的安装说明。与为人类读者编写的传统文档不同，install.md 将安装步骤呈现为由 AI agent 自主执行的直接命令。 Mintlify 会通过聚合和整理与安装相关的文档页面，在你的项目根目录自动生成一个 install.md 文件。该文件始终保持最新，无需维护。 在你的文档站点的 URL 末尾添加 /install.md 即可查看 install.md。 打开此站点的 install.md。

​
install.md 的工作原理

Mintlify 会通过匹配页面路径和标题中的关键词，自动识别文档中包含安装相关内容的页面。被隐藏的页面以及被排除在索引编入之外的页面会被自动过滤。
  • installation 或 install
  • quickstart 或 quick-start
  • getting-started 或 getting_started
  • setup 或 set-up
  • introduction 或 intro
  • overview
Mintlify 会将这些页面整合为一种简洁、以任务为导向的格式，并针对 AI agent 的执行进行了优化。
  1. 提取所有 shell 命令、URL 和平台特定的说明。
  2. 将内容重组为具有明确目标和成功标准的结构。
  3. 以直接可执行命令的形式呈现步骤，而不是被动的说明文档。
  4. 为 agent 提供一个 TODO 清单以跟踪进度。
  5. 移除故障排查部分和可选功能，以聚焦核心安装路径。
在以下情况下，Mintlify 不会生成 install.md 文件：
  • 文档是私有的或需要认证。
  • 项目根目录中已有自定义的 install.md 文件。
  • 在文档中未找到任何与安装相关的页面。

​
install.md 结构

install.md 文件是一个纯 Markdown 文件，包含：
  • 对话式开场：将内容表述为用户请求，以触发自主执行。
  • 目标说明：清晰描述需要安装的内容和目标。
  • 成功条件：用于证明安装成功的具体、可度量结果。
  • TODO 清单：高层级的任务列表。
  • 详细说明：包含所有必要 shell 命令的分步指令。
  • 执行指令：用于触发立即执行的结束语句。

​
自定义 install.md

要添加自定义的 install.md 文件，请在项目根目录创建一个 install.md 文件。添加自定义文件会覆盖自动生成的文件。如果你删除该自定义文件，Mintlify 会重新生成一个新的 install.md 文件。 你的自定义 install.md 文件应采用任务导向的格式，包括对话式的开头、清晰的目标、成功判定标准，以及一个 TODO 清单，以在与 AI 代理协同工作时发挥最大效果。
如需停用 install.md，请发送邮件至 [email protected]。