diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..a49e5fe --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,84 @@ +当然可以,下面是完整的中文翻译版,保持了原文的结构与语气,适合直接放在项目的 `AGENTS.zh-CN.md` 中使用👇 + +--- + +# 仓库指南(Repository Guidelines) + +本仓库托管了 **Tootaio Studio** 网站项目,基于 **Nuxt 4**、`@nuxt/content`、`@nuxt/ui` 和 i18n 构建。 +项目使用 **pnpm** 进行全部工作流程。 + +--- + +## 项目结构与模块组织 + +* `app/` — Nuxt 应用源码目录,包含:`pages/`、`layouts/`、`assets/`、`composables/`、`utils/` 等(例如:`app/pages/index.vue`)。 +* `content/` — 基于 YAML 的多语言内容文件(如:`content/en-US`、`content/zh-CN`)。内容结构定义在 `content.config.ts` 中。 +* `i18n/` — UI 翻译文件(JSON 格式),位于 `i18n/locales//`。 +* `public/` — 静态资源目录,内容将原样提供给客户端。 +* 根级配置文件包括:`nuxt.config.ts`、`eslint.config.mjs`、`pnpm-workspace.yaml`。项目文档存放于 `docs/`。 + +--- + +## 构建、测试与开发命令 + +* **安装依赖**:`pnpm i`(会自动执行 `nuxt prepare`) +* **开发服务器**:`pnpm dev` — 启动后访问 [http://localhost:3000](http://localhost:3000),支持 HMR。 +* **生产构建**:`pnpm build` — 生成 `.output/` 目录。 +* **预览构建**:`pnpm preview` — 以生产模式运行构建产物。 +* **静态生成**:`pnpm generate` — 执行 SSG(静态站点生成)。 +* **代码检查**:`pnpm exec eslint .`(手动执行时使用;CI 流程中会自动运行)。 + +--- + +## 代码风格与命名规范 + +* 使用 **TypeScript** 与 Vue 3 `