72 lines
2.8 KiB
Markdown
72 lines
2.8 KiB
Markdown
# CLAUDE.md
|
||
|
||
此文件为 Claude Code (claude.ai/code) 在处理此仓库代码时提供指导。
|
||
|
||
## 项目概述
|
||
|
||
Antigravity Kit 是一个 AI 驱动的设计智能工具包，提供可搜索的 UI 风格、配色方案、字体配对、图表类型和 UX 指南数据库。它作为 AI 编程助手（Claude Code、Windsurf、Cursor 等）的技能/工作流使用。
|
||
|
||
## 搜索命令
|
||
|
||
```bash
|
||
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "<查询>" --domain <领域> [-n <最大结果数>]
|
||
```
|
||
|
||
**领域搜索：**
|
||
- `product` - 产品类型推荐（SaaS、电商、作品集）
|
||
- `style` - UI 风格（玻璃态、极简主义、野兽派）
|
||
- `typography` - 字体配对及 Google Fonts 导入
|
||
- `color` - 按产品类型的配色方案
|
||
- `landing` - 页面结构和 CTA 策略
|
||
- `chart` - 图表类型和库推荐
|
||
- `ux` - 最佳实践和反模式
|
||
- `prompt` - AI 提示和 CSS 关键词
|
||
|
||
**技术栈搜索：**
|
||
```bash
|
||
python3 .claude/skills/ui-ux-pro-max/scripts/search.py "<查询>" --stack <技术栈>
|
||
```
|
||
可用技术栈：`html-tailwind`（默认）、`react`、`nextjs`、`vue`、`svelte`、`swiftui`、`react-native`、`flutter`、`shadcn`
|
||
|
||
## 架构
|
||
|
||
```
|
||
.claude/skills/ui-ux-pro-max/ # Claude Code 技能
|
||
├── SKILL.md # 包含工作流指令的技能定义
|
||
├── scripts/
|
||
│ ├── search.py # CLI 入口点
|
||
│ └── core.py # BM25 + 正则混合搜索引擎
|
||
└── data/ # CSV 数据库（风格、颜色、排版等）
|
||
└── stacks/ # 特定技术栈指南（8 个 CSV 文件）
|
||
|
||
.windsurf/workflows/ # Windsurf 工作流副本
|
||
.agent/workflows/ui-ux-pro-max/ # 通用代理工作流副本
|
||
.github/prompts/ # GitHub Copilot 提示
|
||
.kiro/steering/ # Kiro 引导文件
|
||
.trae/skills/ui-ux-pro-max/ # Trae 技能副本
|
||
.shared/ui-ux-pro-max/ # 共享数据副本
|
||
```
|
||
|
||
搜索引擎使用 BM25 排名结合正则匹配。当省略 `--domain` 时可自动检测领域。
|
||
|
||
## 同步规则
|
||
|
||
修改文件时，保持所有代理工作流同步：
|
||
|
||
- **数据和脚本**（`data/`、`scripts/`）：将更改复制到 `.shared/ui-ux-pro-max/` 和 `cli/assets/.shared/ui-ux-pro-max/`
|
||
- **SKILL.md**：更新 `.agent/`、`.cursor/`、`.windsurf/`、`.github/prompts/`、`.kiro/steering/`、`.trae/skills/` 中的相应文件
|
||
- **CLI 资源**：将所有技能文件夹复制到 `cli/assets/`（`.claude/`、`.cursor/`、`.windsurf/`、`.agent/`、`.github/`、`.kiro/`、`.trae/`、`.shared/`）
|
||
|
||
## 前置要求
|
||
|
||
Python 3.x（无需外部依赖）
|
||
|
||
## Git 工作流
|
||
|
||
永远不要直接推送到 `main`。始终：
|
||
|
||
1. 创建新分支：`git checkout -b feat/...` 或 `fix/...`
|
||
2. 提交更改
|
||
3. 推送分支：`git push -u origin <分支>`
|
||
4. 创建 PR：`gh pr create`
|