CLAUDE.md

1# CLAUDE.md
2 
3> 本文件为 Claude Code CLI 提供项目特定配置和指导。
4 
5## 项目概述
6 
7**awesome-cursorrules-zh** 是一个 Cursor AI 编辑器规则集合网站，提供精选的 `.cursorrules` 规则文件。
8 
9## 技术栈
10 
11| 技术 | 版本 | 用途 |
12|------|------|------|
13| Node.js | >=20.0.0 | 运行时 |
14| VitePress | ^1.6.4 | 静态站点生成 |
15| markdownlint-cli2 | ^0.22.1 | Markdown 检查 |
16 
17## 常用命令
18 
19```bash
20npm run dev          # 启动开发服务器
21npm run build        # 构建静态站点
22npm run preview      # 预览构建结果
23npm run lint         # Markdown 格式检查
24npm run lint:fix     # 自动修复格式问题
25npm run validate     # 验证规则文件
26npm run check        # lint + validate
27npm run ci           # check + build
28```
29 
30## 目录结构
31 
32```
33awesome-cursorrules-zh/
34├── .vitepress/           # VitePress 配置
35├── docs/                 # 文档源文件
36│   ├── zh/               # 中文文档
37│   └── en/               # 英文文档
38├── zh/                   # 中文站点页面（符号链接）
39├── en/                   # 英文站点页面（符号链接）
40├── rules/                # 规则文件（核心）
41├── scripts/              # 工具脚本
42├── AGENTS.md             # AI 助手工作指南
43└── CLAUDE.md             # 本文件
44```
45 
46## 开发工作流
47 
48### 添加新规则
49 
501. 在 `rules/` 对应领域下创建目录
512. 编写 `.cursorrules` 文件
523. 编写 `README.md` 说明
534. 运行 `npm run validate` 验证
54 
55### 文档更新
56 
571. 更新 `docs/zh/` 中文文档
582. 更新 `docs/en/` 英文文档
593. 运行 `npm run lint` 检查格式
60 
61### 提交规范
62 
63使用约定式提交：`feat`/`fix`/`docs`/`chore`/`translate`
64 
65## 规则文件规范
66 
67### 标准模板
68 
69```markdown
70# [技术名称] .cursorrules 提示文件
71 
72你是 [技术领域] 方面的专家。
73 
74## 核心原则
75 
76- 原则1
77- 原则2
78 
79## 技术栈
80 
81- 技术1
82- 技术2
83 
84## 最佳实践
85 
861. 实践1
872. 实践2
88```
89 
90### 质量要求
91 
92- 文件大小 >= 200 字节
93- 必须包含角色定义
94- 推荐包含最佳实践
95- 使用中文编写
96 
97## 双语支持
98 
99- 文档：`docs/zh/` 和 `docs/en/`
100- 规则文件：中文为主
101- 技术术语：保持英文原文
102 
103## CI/CD
104 
105| 工作流 | 触发 | 功能 |
106|--------|------|------|
107| ci.yml | push/PR | 质量检查 + 构建 |
108| deploy.yml | push main | 部署 GitHub Pages |
109 
110## 注意事项
111 
1121. **规则验证**：所有规则文件必须通过 `npm run validate`
1132. **Markdown 格式**：遵循 `.markdownlint.json` 配置
1143. **提交规范**：使用约定式提交
1154. **双语更新**：文档更新需同步中英文
116 
117## 相关文档
118 
119- [AGENTS.md](./AGENTS.md) - AI 助手工作指南
120- [CONTRIBUTING.md](./CONTRIBUTING.md) - 贡献指南
121