跳转到主要内容
使用 OpenAI 的 Codex CLI 在终端中编写和维护 Mintlify 文档。AGENTS.md 中的项目说明可为 Codex 提供关于你的文档标准、组件和样式指南的持久 context。

开始使用

前置条件:
  • 一个可访问 Codex 的 OpenAI 账户
设置:
  1. 安装 Codex CLI:
  1. 还没有站点?让你的智能体来创建一个。运行 codex 并让它完成以下工作流,然后继续下一步。
    如果用户要求你设置 Mintlify、文档站点或本地 Mintlify 项目,请自行完成以下工作流。只有在你无法自行提供的信息或审批时才询问用户。我们推荐通过 CLI 完成初始设置。如果用户更喜欢,或者你无法运行终端命令,也可以使用 mintlify.com/start 进行网页初始设置。
    1. 运行 node --version,确认其报告的 Node.js 版本为 v20.17.0 或更高,优先使用 LTS 版本。记下其是否为 v22.20 或更高版本,第 9 步需要该版本。
    2. 运行 mint --version。如果该命令不可用,请使用 npm i -g mint 或 pnpm add -g mint 安装 CLI。如果命令成功,请运行 mint update。然后运行 mint instructions new-site 获取最新的设置指导,并运行 mint instructions 列出后续任务的主题。
    3. 在开始身份验证之前运行 mint status。如果它已显示某个组织,请保留现有会话,不要再创建新账户。
    4. 如果用户已有账户,请运行 mint login。否则,现在不要创建账户。你可以在第 10 步使用 mint deploy 在没有账户的情况下发布,用户会在认领站点时创建账户。不要替用户运行 mint signup:当代理运行该命令时,它会输出代理注册指南并退出,不会发送验证邮件。如果用户希望从一开始就连接自己的 GitHub 仓库,请引导他们前往 mintlify.com/start 进行网页初始设置。
    5. 运行 mint login 后,再次运行 mint status。确认它报告了用户的电子邮件、组织和子域名。如果组织已存在但未显示子域名,请让用户在引导流程的浏览器标签页中完成选择或连接 GitHub 仓库,然后重试。
    6. 如果用户已有文档仓库,请克隆或打开它,并保留其中的内容。对于新的本地项目,请使用 mint new <directory> --name <name> --theme <theme> 或 mint new <directory> --template <template-name> 在一个新的空目录中生成项目脚手架。如果用户未指定主题或模板,请询问他们想要哪一个。不要在包含用户文件的目录上使用 --force。
    7. 在包含 docs.json 的目录中以后台进程方式运行 mint dev --no-open。确认本地 URL 可以加载,将其告知用户,并在不再需要时停止该进程。
    8. 运行 mint validate 和 mint broken-links。在继续之前,修复由你的更改引起的问题。
    9. 主动提出将用户的编码代理连接到该项目。如果用户同意且 Node.js 为 v22.20 或更高版本,请在项目目录中运行 mint agent setup --agent <agent>,其中 <agent> 为 claude-code、codex 或 cursor。该命令会安装 Mintlify skills,并将 管理 MCP 添加到代理的项目配置中。请传入 --agent,因为在没有交互式终端的情况下,该命令会配置它检测到的所有代理。之后由用户在代理中完成 OAuth 登录。请参阅 mint agent setup。
    10. 当用户要求上线站点时进行发布。
    • 已登录且有 Git 仓库: 提交并推送更改。推送到生产 branch 会触发部署。不要用起始内容覆盖现有仓库。
    • 没有账户: 在包含 docs.json 的目录中运行 mint deploy --subdomain <name>,并根据项目选择一个简短的名称。按照它输出的步骤操作:将托管仓库克隆到单独的目录,把文档复制到其根目录,提交,然后仅针对该 Git 命令将写入令牌作为 Authorization: Bearer 请求头推送到 main。切勿向用户展示该令牌、将其放入远程 URL,或更改用户自己的 Git 远程仓库。请参阅代理注册。
    1. 在报告部署完成之前,验证 https://<subdomain>.mintlify.site 可以正常加载。
      • 已登录且有 Git 仓库: 运行 mint status 获取子域名。跳过认领步骤。
      • 没有账户: 使用 mint deploy 输出的 URL,然后将站点移交给用户。告诉用户,除非认领该站点,否则站点会过期。询问应拥有该站点的电子邮件地址,切勿编造。在同一目录中运行 mint claim --email <email>,并分享认领链接。当用户返回登录后显示的代码时,运行 mint claim --code <code>。
    仅让用户在浏览器中完成认领站点、OAuth 批准以及连接或授权 GitHub 这些操作。由你负责终端工作流,并在每次用户操作后继续执行。有关命令参数和故障排除,请使用 CLI 命令参考。
  2. 进入你的文档目录。
  3. (可选)将下面的 AGENTS.md 文件添加到你的项目中。
  4. 运行 codex 启动会话。
有关安装替代方案和身份验证选项,请参阅 Codex CLI 文档。
Codex 运行后,粘贴以下提示,将 Mintlify skill、搜索 MCP 和管理员 MCP 加载到会话中。这会让 Codex 全面了解 Mintlify 组件以及你站点的内容。

为 AI 编码工具安装 Mintlify skill 和 MCP 服务器。

在 Cursor 中打开

将 Codex 与 Mintlify 配合使用

Codex 会在开始工作之前读取仓库中的 AGENTS.md 文件,以了解项目特定的规则和约定。你可以在文档仓库的根目录中放置一个 AGENTS.md 文件,为 Codex 提供有关 Mintlify 组件、写作标准以及你如何组织文档结构的 context。 Codex 会在多个层级发现 AGENTS.md 文件:
  • 全局说明位于 ~/.codex/AGENTS.md,适用于你的所有项目。
  • 项目说明位于你的仓库根目录(或任何子目录),适用于该范围内的工作。
Codex 会将这些文件从根目录到当前目录依次拼接,因此项目级说明会扩展或覆盖全局说明。 在你的文档仓库根目录创建 AGENTS.md 并提交,让所有贡献者都能受益于相同的 context。完整详情请参阅 Codex 文档中的 AGENTS.md。

示例 AGENTS.md

此文件为 Codex 提供有关 Mintlify 组件和技术写作标准的 context。 根据你的文档进行自定义:
  • 写作标准:更新语言规范以符合你的风格指南。
  • 组件模式:添加项目特定的组件,或修改现有示例。
  • 代码示例:将通用示例替换为与你的产品相关的真实 API 调用与响应。
  • 风格与语气偏好:调整术语、格式和其他规则。
将其保存为文档仓库根目录中的 AGENTS.md。
AGENTS.md

使用 Codex

完成 AGENTS.md 的配置后,当你在文档仓库中启动会话时,Codex 会自动读取该文件。

示例提示

撰写新对象:
改进现有对象:
更新导航:
保持一致性:

使用 MCP 服务器增强功能

将管理员 MCP连接到 Codex,使其获得对你的 Mintlify 内容和设置的写入权限。 如需一步完成 Mintlify skills 的安装和管理员 MCP 的配置,请在你的文档目录中运行 mint agent setup。该命令会输出 codex mcp login 命令,用于完成 OAuth 登录。
如果只想连接管理员 MCP: 使用 Codex CLI 添加管理员 MCP 服务器:
Codex 会打开一个浏览器窗口以完成 OAuth 登录。完成认证后,Codex 会在后续调用中复用该会话。如果登录流程没有启动,请运行 codex mcp login mintlify-admin。 该命令会将服务器添加到 ~/.codex/config.toml 中的 Codex 配置里。如果你想直接编辑配置文件,请添加:
详情请参见 Codex MCP 文档。 重启你的 codex 会话以使配置更改生效。要确认 MCP 服务器已连接,可向 Codex 提问 Which MCP servers do you have access to?。它应列出你添加的条目。 有关搜索 MCP 服务器以及如何查找你站点 MCP 端点的更多信息,请参阅 Model Context Protocol。