Anydocs Documents
快速开始

第一个文档项目

用一条最短路径完成初始化、编辑、发布和预览。

这页给出从空目录到首个可访问 reader 页面的最短链路。面向人工写作和 AI 协作,这四步都一样:初始化、编辑、发布、预览。

1. 初始化项目

npx @anydocs/cli init ./my-docs

如果你计划让 Codex 或 Claude Code 直接参与写作,把 `--agent codex` 或 `--agent claude-code` 一起加上。

2. 打开项目并确认起步内容

在 Studio 中打开 `./my-docs`。确认默认语言、欢迎页、导航和站点标题都符合预期,再开始扩写真实内容。

3. 写页面并切到 `published`

在编辑器中完成正文、标题、slug 和描述。页面只有在状态变成 `published` 后,才会出现在 reader、搜索索引、`llms.txt` 和 `mcp/` 产物里。

4. 预览读者站点

npx @anydocs/cli preview ./my-docs

`preview` 默认就是 live 模式。它会打印本地 URL,并跳到默认语言下的第一个已发布页面。

如果你让 AI 参与交付

优先让 AI 通过 Anydocs MCP 创建页面、更新内容、维护导航和切换状态,不要把直接编辑 `pages/*.json` 或 `navigation/*.json` 当成常规流程。

guide 文件规则

  • 默认不指定 `--agent` 时生成 `skill.md`
  • `--agent codex` 生成 `AGENTS.md`
  • `--agent claude-code` 生成 `CLAUDE.md` 和 `.claude/commands/`