Anydocs Documents
快速开始

与 Codex 配合使用

学习如何在 Codex 中使用 Anydocs 进行 AI 辅助文档编写。

把 Anydocs 接到 Codex 的推荐方式是:注册 `@anydocs/mcp`,用 CLI 初始化项目,然后让 Codex 通过 MCP 完成页面、导航和状态操作。除非你在开发 Anydocs 本身,否则不需要从源码运行。

1. 安装

安装 Anydocs MCP 服务,请参考安装文档中的 MCP 快捷命令。安装为全局配置后,在任何 Codex 项目中都可以直接使用。

codex mcp add anydocs -- npx -y @anydocs/mcp

安装完成后可以通过 `codex mcp list` 确认已注册的 server。

2. 初始化一个适合 Codex 的项目

npx @anydocs/cli init ./my-docs --agent codex

这个命令会在项目根目录生成 `AGENTS.md`,作为 Codex 的最小入口 guide。

3. 在 Codex 中让 AI 做什么

让 Codex 优先通过 Anydocs MCP 完成这些动作:

  • 打开项目并读取 contract
  • 创建页面和更新正文
  • 维护导航结构
  • 切换页面状态
  • 在交付前运行校验,再决定是否执行 `preview` 或 `build`

这样可以复用 canonical 校验规则和模板能力,而不是直接编辑 `pages/*.json` 或 `navigation/*.json`。

4. 什么时候预览,什么时候构建

用 `preview` 检查 reader 的真实效果;用 `build` 生成最终静态站点、搜索索引和 AI 产物。两者都只暴露 `published` 页面。

npx @anydocs/cli preview ./my-docs
npx @anydocs/cli build ./my-docs