Anydocs Documents
核心概念

项目结构

了解一个标准 Anydocs 文档项目的目录组织。

Anydocs 把文档项目与框架源码仓库分开。日常写作面向的是文档项目根目录,其中包含页面、导航和配置,而不是 Anydocs 自身的 `packages/` 源码。

典型目录

my-docs/
├── anydocs.config.json
├── anydocs.workflow.json
├── pages/
│   ├── zh/
│   └── en/
├── navigation/
│   ├── zh.json
│   └── en.json
├── imports/
├── dist/
└── skill.md

必需内容

一个启用语言要正常工作,至少需要该语言的页面目录与导航文件。

  • `pages/<lang>/`:该语言下的页面 JSON
  • `navigation/<lang>.json`:该语言下的导航树
  • `anydocs.config.json`:项目级配置

常见可选内容

下面这些目录或文件会在特定流程中出现。

  • `imports/`:旧文档导入的暂存区
  • `dist/`:build 产物目录
  • `skill.md`:项目级 AI 辅助说明,是否生成取决于初始化方式
  • `anydocs.workflow.json`:工作流配置