diff --git a/README.zh.md b/README.zh.md index 2cb5f1a..c3e57f7 100644 --- a/README.zh.md +++ b/README.zh.md @@ -7,15 +7,15 @@

GitHub Release - 100 条推理规则 + 161 条推理规则 67 种 UI 风格 Python 3.x License

- npm - npm downloads + npm + npm downloads GitHub stars PayPal

@@ -42,7 +42,7 @@ ### 智能设计系统生成 -v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理引擎，可在数秒内分析您的项目需求并生成完整、定制化的设计系统。 +v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理引擎，可在数秒内分析你的项目需求并生成完整、定制化的设计系统。 ``` +----------------------------------------------------------------------------------------+ @@ -106,9 +106,9 @@ v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理 ▼ ┌─────────────────────────────────────────────────────────────────┐ │ 2. 多域搜索 (5 个并行搜索) │ -│ • 产品类型匹配 (100 个分类) │ +│ • 产品类型匹配 (161 个分类) │ │ • 风格推荐 (67 种风格) │ -│ • 配色方案选择 (96 套配色) │ +│ • 配色方案选择 (161 套配色) │ │ • 落地页模式 (24 种模式) │ │ • 字体配对 (57 种组合) │ └─────────────────────────────────────────────────────────────────┘ @@ -130,19 +130,20 @@ v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理 └─────────────────────────────────────────────────────────────────┘ ``` -### 100 条行业特定推理规则 +### 161 条行业特定推理规则 推理引擎包含针对以下领域的专门规则： | 分类 | 示例 | |------|------| -| **科技与 SaaS** | SaaS、微 SaaS、B2B 企业级、开发者工具、AI/聊天机器人平台 | -| **金融** | 金融科技、银行、加密货币、保险、交易仪表板 | -| **医疗健康** | 医疗诊所、药房、牙科、兽医、心理健康 | -| **电子商务** | 综合电商、奢侈品、 marketplace、订阅盒 | -| **服务** | 美容/水疗、餐饮、酒店、法律、咨询 | -| **创意** | 作品集、代理公司、摄影、游戏、音乐流媒体 | -| **新兴技术** | Web3/NFT、空间计算、量子计算、自动驾驶系统 | +| **科技与 SaaS** | SaaS、微 SaaS、B2B 服务、开发者工具 / IDE、AI/聊天机器人平台、网络安全平台 | +| **金融** | 金融科技/加密货币、银行、保险、个人财务追踪、发票与账单工具 | +| **医疗健康** | 医疗诊所、药房、牙科、兽医、心理健康、用药提醒 | +| **电子商务** | 综合电商、奢侈品、二手交易平台 (P2P)、订阅盒、外卖配送 | +| **服务** | 美容/水疗、餐饮、酒店、法律、家政服务、预约与预订 | +| **创意** | 作品集、代理公司、摄影、游戏、音乐流媒体、照片/视频编辑器 | +| **生活方式** | 习惯追踪、食谱与烹饪、冥想、天气、日记、情绪追踪 | +| **新兴技术** | Web3/NFT、空间计算、量子计算、自动驾驶无人机编队 | 每条规则包括： - **推荐模式** - 落地页结构 @@ -155,12 +156,12 @@ v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理 ## 功能特性 - **67 种 UI 风格** - 玻璃拟态、粘土拟态、极简主义、粗野主义、新拟态、便当盒网格、深色模式、AI 原生 UI 等 -- **96 套配色方案** - 针对 SaaS、电商、医疗健康、金融科技、美容等行业的专属调色板 +- **161 套配色方案** - 与 161 种产品类型 1:1 对齐的行业专属调色板 - **57 种字体配对** - 精选字体组合，含 Google Fonts 导入 - **25 种图表类型** - 适用于仪表板和分析场景的推荐 -- **13 种技术栈** - React、Next.js、Astro、Vue、Nuxt.js、Nuxt UI、Svelte、SwiftUI、React Native、Flutter、HTML+Tailwind、shadcn/ui、Jetpack Compose +- **22 种技术栈** - React、Next.js、Astro、Vue、Nuxt.js、Nuxt UI、Svelte、SwiftUI、React Native、Flutter、HTML+Tailwind、shadcn/ui、Jetpack Compose、Angular、Laravel、Three.js、JavaFX、WPF、WinUI 3、UWP、Avalonia、Uno Platform - **99 条 UX 指南** - 最佳实践、反模式与无障碍规则 -- **100 条推理规则** - 行业特定的设计系统生成（v2.0 新增） +- **161 条推理规则** - 行业特定的设计系统生成（v2.0 新增） ### 可用风格 (67) @@ -255,6 +256,25 @@ v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理 +## 💎 基础版与高级版对比 + +许多用户询问开源版与高级版之间的差异。以下是详细的对比，帮助你选择适合自己工作流的版本。 + +### 🟢 基础版（本仓库） +* **完全开源：** 适合个人开发者、爱好者及标准项目。 +* **核心 UI/UX 智能：** 完整支持 67 种 UI 风格、161 种产品类型、配色方案和精选字体配对。 +* **智能推荐：** 内置 BM25 搜索引擎，提供高精度的设计匹配。 +* **跨平台支持：** 提供针对 13+ 主流框架（React、Vue、Tailwind、iOS、Android 等）的技术栈专属指南。 +* **设计系统生成：** 通过 CLI 即时生成定制化的 UI 规则、模式与逻辑。 + +### 🟡 高级版 +* **扩展的品牌设计能力：** 超越 UI/UX 范畴，涵盖品牌标识生成、Logo 设计、企业识别系统 (CIP)、横幅、演示文稿幻灯片及自定义图标设计。 +* **高级资产生成：** 深度集成 AI 图像生成能力，创建真实视觉素材而非占位符。 +* **企业级架构：** 更全面、可扩展的设计令牌 (Design Token) 架构，面向大规模团队部署。 +* **优先支持：** 为需要不间断完整设计工作流的团队和专业人士提供专属技术支持。 + +👉 *如需了解升级到高级版的更多详情，请访问 [uupm.cc](https://uupm.cc)。* + ## 安装 ### 使用 Claude Marketplace (Claude Code) @@ -270,7 +290,7 @@ v2.0 的旗舰特性是**设计系统生成器**——一个 AI 驱动的推理 ```bash # 全局安装 CLI -npm install -g uipro-cli +npm install -g ui-ux-pro-max-cli # 进入你的项目 cd /path/to/your/project @@ -291,15 +311,30 @@ uipro init --ai opencode # OpenCode uipro init --ai continue # Continue uipro init --ai codebuddy # CodeBuddy uipro init --ai droid # Droid (Factory) +uipro init --ai kilocode # KiloCode +uipro init --ai warp # Warp +uipro init --ai augment # Augment uipro init --ai all # 所有助手 ``` +npm 包名为 `ui-ux-pro-max-cli`；它仍然安装 `uipro` 命令。旧版 `uipro-cli` 已过时，不应用于当前资源。 + +### 全局安装（适用于所有项目） + +```bash +uipro init --ai claude --global # 安装到 ~/.claude/skills/ +uipro init --ai cursor --global # 安装到 ~/.cursor/skills/ +``` + ### 其他 CLI 命令 ```bash uipro versions # 列出可用版本 -uipro update # 更新到最新版本 -uipro init --offline # 跳过 GitHub 下载，使用捆绑资源 +uipro update # 从已安装的 CLI 包刷新技能文件 +uipro init --offline # 兼容性标志；安装捆绑模板 +uipro uninstall # 移除技能（自动检测平台） +uipro uninstall --ai claude # 移除特定平台 +uipro uninstall --global # 移除全局安装 ``` ## 前置要求 @@ -324,7 +359,7 @@ winget install Python.Python.3.12 ### 技能模式 (自动激活) -**支持：** Claude Code、Cursor、Windsurf、Antigravity、Codex CLI、Continue、Gemini CLI、OpenCode、Qoder、CodeBuddy、Droid (Factory) +**支持：** Claude Code、Cursor、Windsurf、Antigravity、Codex CLI、Continue、Gemini CLI、OpenCode、Qoder、CodeBuddy、Droid (Factory)、KiloCode、Warp、Augment 当你请求 UI/UX 工作时，技能会自动激活。只需自然地聊天： @@ -336,7 +371,7 @@ winget install Python.Python.3.12 ### 工作流模式 (斜杠命令) -**支持：** Kiro、GitHub Copilot、Roo Code +**支持：** Kiro、GitHub Copilot、Roo Code、KiloCode 使用斜杠命令调用技能： @@ -375,7 +410,10 @@ winget install Python.Python.3.12 | **Web (HTML)** | HTML + Tailwind (默认) | | **React 生态** | React、Next.js、shadcn/ui | | **Vue 生态** | Vue、Nuxt.js、Nuxt UI | -| **其他 Web** | Svelte、Astro | +| **Angular** | Angular | +| **PHP** | Laravel (Blade、Livewire、Inertia.js) | +| **其他 Web** | Svelte、Astro、Three.js | +| **桌面端** | JavaFX | | **iOS** | SwiftUI | | **Android** | Jetpack Compose | | **跨平台** | React Native、Flutter | @@ -403,6 +441,9 @@ python3 .claude/skills/ui-ux-pro-max/scripts/search.py "dashboard" --domain char # 特定技术栈指南 python3 .claude/skills/ui-ux-pro-max/scripts/search.py "form validation" --stack react python3 .claude/skills/ui-ux-pro-max/scripts/search.py "responsive layout" --stack html-tailwind +python3 .claude/skills/ui-ux-pro-max/scripts/search.py "tableview binding" --stack javafx +python3 .claude/skills/ui-ux-pro-max/scripts/search.py "atlantafx primer enterprise theme" --stack javafx +python3 .claude/skills/ui-ux-pro-max/scripts/search.py "enterprise tableview density permission" --stack javafx ``` ### 持久化设计系统 (主配置 + 覆盖模式) @@ -449,11 +490,11 @@ design-system/ **始终使用 CLI 安装：** ```bash -npm install -g uipro-cli +npm install -g ui-ux-pro-max-cli uipro init --ai ``` -这确保你获得最新模板和适用于 AI 助手的正确文件结构。 +这确保你获得随已安装 CLI 包捆绑的最新模板，以及适用于 AI 助手的正确文件结构。发布新版本时请先更新 npm 包。 ### 对于贡献者 @@ -476,12 +517,12 @@ cli/ # CLI 安装器 (从模板生成文件) # - templates/ → 平台特定模板 # 4. 同步到 CLI 并本地测试 -cp -r src/ui-ux-pro-max/data/* cli/assets/data/ -cp -r src/ui-ux-pro-max/scripts/* cli/assets/scripts/ -cp -r src/ui-ux-pro-max/templates/* cli/assets/templates/ +cd cli +npm run sync:assets +npm run check:assets # 5. 构建并测试 CLI -cd cli && bun run build +bun run build node dist/index.js init --ai claude --offline # 在临时文件夹中测试 # 6. 创建 PR (永远不要直接推送到 main) @@ -493,6 +534,95 @@ gh pr create 详细的开发指南请参见 [CLAUDE.md](CLAUDE.md)。 +## 自动化发布 + +本仓库使用 semantic-release 配合约定式提交 (Conventional Commits) 自动创建 GitHub 发布： + +- `dev` 分支创建 beta GitHub 预发布，如 `2.6.0-beta.1`。 +- `main` 分支创建官方稳定版 GitHub 发布，如 `2.6.0`。 + +发布说明和 `CHANGELOG.md` 根据约定式提交信息生成。在发布准备期间，版本号会在 `skill.json`、`.claude-plugin/plugin.json`、`.claude-plugin/marketplace.json`、`cli/package.json` 和 `cli/package-lock.json` 之间同步。 + +使用以下提交类型以获得正确的版本号升级： + +- `fix:` -> 补丁版本发布 +- `feat:` -> 次版本发布 +- `feat!:` 或 `BREAKING CHANGE:` -> 主版本发布 + +发布工作流使用默认的 `GITHUB_TOKEN` 创建 GitHub 发布，并使用仓库的 `NPM_TOKEN` 密钥将 `ui-ux-pro-max-cli` 发布到 npm。 + +## 故障排查 + +### `uipro: unknown command 'uninstall'` 或 `unknown command 'update'` + +你安装的 `ui-ux-pro-max-cli` 版本已过时。请更新后重试： + +```bash +npm install -g ui-ux-pro-max-cli@latest +uipro uninstall +``` + +### `uipro uninstall` 提示 "No installed AI skill directories detected" + +技能安装在与运行命令不同的目录中。可以： + +```bash +# 方案 A — 切换到最初安装它的项目根目录 +cd /path/to/your/project +uipro uninstall + +# 方案 B — 移除全局安装 +uipro uninstall --global + +# 方案 C — 手动移除 +rm -rf .claude/skills/ui-ux-pro-max # Claude Code +rm -rf .cursor/skills/ui-ux-pro-max # Cursor +rm -rf .windsurf/skills/ui-ux-pro-max # Windsurf +rm -rf .agents/skills/ui-ux-pro-max # Antigravity +``` + +### Claude Marketplace 安装失败，提示 "Zip file contains a symbolic link" + +这是 v2.5.1 之前版本的已知问题。仓库内部使用了符号链接，某些安装工具无法处理。**解决办法：** 改用 CLI 安装器： + +```bash +npm install -g ui-ux-pro-max-cli +uipro init --ai claude +``` + +或等待下一个已修复此问题的版本发布。 + +### `npm install -g ui-ux-pro-max-cli` 失败，提示权限错误 + +```bash +# macOS/Linux — 使用 Node 版本管理器（推荐）或 sudo +sudo npm install -g ui-ux-pro-max-cli + +# 或使用 npx 而不全局安装 +npx ui-ux-pro-max-cli init --ai claude +``` + +### 运行设计系统命令时找不到 Python + +搜索脚本需要 Python 3.x。请根据你的操作系统安装： + +```bash +brew install python3 # macOS +sudo apt install python3 # Ubuntu/Debian +winget install Python.Python.3.12 # Windows +``` + +### 设计系统输出被截断 / 字段不完整 + +使用 `--max-length` 标志增加（或取消）截断限制： + +```bash +python3 .claude/skills/ui-ux-pro-max/scripts/search.py "SaaS" --domain style --max-length 0 +# ^ 0 = 不限制 +``` + +--- + ## Star 历史 [![Star History Chart](https://api.star-history.com/svg?repos=nextlevelbuilder/ui-ux-pro-max-skill&type=Date)](https://star-history.com/#nextlevelbuilder/ui-ux-pro-max-skill&Date) @@ -500,3 +630,9 @@ gh pr create ## 许可证 本项目采用 [MIT 许可证](LICENSE) 授权。 + +## 兼容的智能体 + +本技能可与以下工具配合使用： +- [Claude Code](https://claude.com/product/claude-code) +- [AdaL](https://sylph.ai/) - 自进化的 AI 编码智能体（[文档](https://docs.sylph.ai/) | [GitHub](https://github.com/SylphAI-Inc/adal-cli)）