Gemini 项目配置 (GEMINI.md)
该文件为 Gemini AI 助手提供指令,以确保其交互和代码修改符合本项目的标准和惯例。
1. 关于本项目
(请在此处添加您项目的简要描述。)
示例:
这是 Fluxion 应用的官方网站,使用 VitePress 构建。它是一个文档和营销网站。主要语言是中文,英文翻译在
/en/目录下。
2. 技术栈
本项目使用以下技术构建。请遵循其最佳实践。
3. 开发命令
以下是运行和构建项目的基本命令。
- 启动开发服务器:
npm run docs:dev - 构建生产版本:
npm run docs:build - 预览生产版本:
npm run docs:preview
交互示例:
用户: “启动开发服务。” Gemini: (执行
npm run docs:dev)
4. 编码风格和惯例
在编写或修改代码和内容时,请遵循以下准则。
- 语言:
- 主要内容为中文。
- 英文内容位于
/en/目录中。 - 为了技术清晰,代码中的注释 (例如
.vitepress/config.mjs) 请尽量使用中文。
- Markdown:
- 保持 Markdown 文件干净、格式良好。
- 使用标准的 Markdown 语法。
- 代码提交 (Commits):
- 提交信息 (commit messages) 请使用英文。
- 遵循“约定式提交”格式 (例如,
feat: add new page,fix: correct typo in intro,docs: update README)。
5. 文件和目录规则
请遵守有关文件结构的这些规则。
- 请勿修改:
node_modules/目录。.vitepress/cache/和.vitepress/dist/目录,因为它们是自动生成的。
- 内容入口:
- 主要 (中文) 内容位于根目录 (例如
index.md,about.md)。 - 英文内容位于
/en/目录。
- 主要 (中文) 内容位于根目录 (例如
- 配置:
- 网站配置在
.vitepress/config.mjs中管理。 - 主题定制在
.vitepress/theme/中。
- 网站配置在
遵循这些说明,您将成为本项目更高效的助手。
