64 lines
3.0 KiB
Markdown
64 lines
3.0 KiB
Markdown
# Aurora Admin Design System
|
||
|
||
理性、高效、克制的 B 端中后台设计系统：**79 个组件 × 5 端实现**（H5 / React / Vue 2 / Vue 3 / CSS），品牌主色 `#2F54EB`，全部色值取自 `au-*` CSS 变量令牌，零运行时依赖。
|
||
|
||
## 在线入口
|
||
|
||
- 组件文档站：[`site/index.html`](./site/index.html)（GitHub Pages 部署后为仓库首页自动跳转）
|
||
- For Agents / llms.txt：[`site/llms.txt`](./site/llms.txt) · [`site/data.json`](./site/data.json)
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
├─ index.html # Pages 入口（重定向到 site/）
|
||
├─ sitemap.xml # 站点地图（构建生成，部署后回填正式域名）
|
||
├─ site/ # 文档站（纯静态，无构建依赖）
|
||
│ ├─ index.html / app.js / style.css / data.js / data.json
|
||
│ ├─ components/<slug>.html # 每组件静态薄壳（SEO 可爬入口，构建生成）
|
||
│ ├─ scenario/user-management.html # 场景示范页（用户管理列表页）
|
||
│ └─ llms.txt
|
||
├─ frameworks/ # 79 组件 × 5 端实现源码（只读引用）
|
||
├─ tests/ # 79 个组件测试页 + 回归报告 report.json
|
||
├─ tools/run-regression.mjs # Playwright 回归 runner（CI 用）
|
||
└─ .design_library/aurora-admin/
|
||
├─ components/index.json # 组件 ↔ 规格 ↔ 实现权威映射
|
||
├─ components/<slug>.json # 设计契约（21 个：6 核心 + 15 输入类第一批）
|
||
├─ colors_and_type.css # 设计令牌（au-* + legacy 双命名）
|
||
└─ components.css # 聚合组件样式
|
||
```
|
||
|
||
## 快速使用
|
||
|
||
```html
|
||
<link rel="stylesheet" href=".design_library/aurora-admin/colors_and_type.css">
|
||
<link rel="stylesheet" href=".design_library/aurora-admin/components.css">
|
||
```
|
||
|
||
按端取用组件源码：`frameworks/<Prefix>.{html,css,jsx,vue2.vue,vue3.vue}`。
|
||
|
||
## 本地开发
|
||
|
||
```bash
|
||
node site/dev-server.js # http://127.0.0.1:3311/site/
|
||
powershell -File build-site.ps1 # 重建 data.js / 薄壳 / sitemap（重建后浏览器 Ctrl+F5）
|
||
powershell -File run-tests.ps1 # 重新生成 79 个测试页
|
||
node tools/run-regression.mjs # headless 回归（需 npm i playwright）
|
||
```
|
||
|
||
## 部署（GitHub Pages）
|
||
|
||
1. GitHub 新建仓库（Public）。
|
||
2. `git remote add origin git@github.com:<account>/aurora-admin.git && git push -u origin main`。
|
||
3. 仓库 Settings → Pages → Source 选 **GitHub Actions**；推送后 `.github/workflows/deploy-pages.yml` 自动部署整仓。
|
||
4. 回填正式域名：`build-site.ps1` 中 `$SiteUrlBase` 改为 `https://<account>.github.io/aurora-admin/`，重跑构建后推送。
|
||
|
||
## 设计契约与 Agent 消费
|
||
|
||
- 组件契约（变体维度 / 使用要点 / 不发明 / 未明示）：`.design_library/aurora-admin/components/*.json`
|
||
- 文档站 `#/agents` 页汇总全部机器可读资源与使用规则
|
||
- 生成 UI 时：色值只取令牌，变体不超出契约 `dims`，`unknowns` 项先澄清再生成
|
||
|
||
## 版本
|
||
|
||
见 [CHANGELOG.md](./CHANGELOG.md)。当前 v1.2.0。
|