@qiqi1996/design-system 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/README.zh-CN.md +77 -0
- package/dist/cli/main +29580 -0
- package/dist/cli/package.json +1 -0
- package/dist/schema-en.json +1 -0
- package/dist/schema-zh.json +1 -0
- package/package.json +68 -0
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Qi Design System
|
|
2
|
+
|
|
3
|
+
Use a unified configuration file to describe the design system, and then automatically generate the configuration of Tailwind, Chakra UI and other UI frameworks.
|
|
4
|
+
|
|
5
|
+
Languages: [中文](./README.zh-CN.md) | [English](./README.md)
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
## Features & Roadmap
|
|
10
|
+
|
|
11
|
+
### Color System Definition
|
|
12
|
+
|
|
13
|
+
- [ ] Color System
|
|
14
|
+
- [ ] Single-color Palette Generation
|
|
15
|
+
- [x] Ant Design Color
|
|
16
|
+
- [ ] Mantine Colors Generator
|
|
17
|
+
- [ ] Triadic Color Scheme
|
|
18
|
+
- [x] Semantic Definition (Based on Chakra UI Semantic Specifications)
|
|
19
|
+
- [ ] Dark Mode
|
|
20
|
+
- [ ] Typography System
|
|
21
|
+
- [x] Font Sizes (Semantic Definition Only)
|
|
22
|
+
- [x] Line Heights
|
|
23
|
+
- [x] Linear Automatic Generation
|
|
24
|
+
- [x] Font Weights (Semantic Definition Only)
|
|
25
|
+
- [x] Spacing System
|
|
26
|
+
- [ ] Border Radii
|
|
27
|
+
- [ ] Shadows
|
|
28
|
+
|
|
29
|
+
### Built-in Configuration Generators
|
|
30
|
+
|
|
31
|
+
- [x] Tailwind V4
|
|
32
|
+
- [ ] Tailwind V3
|
|
33
|
+
- [ ] Ant Design
|
|
34
|
+
- [ ] Chakra UI
|
|
35
|
+
- [ ] Mantine
|
|
36
|
+
|
|
37
|
+
## Contribution
|
|
38
|
+
|
|
39
|
+
* Requires the Bun runtime environment (v1.3.0+).
|
package/README.zh-CN.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Qi Design System
|
|
2
|
+
|
|
3
|
+
使用统一的配置文件去描述设计系统, 然后自动生成到 Tailwind、Chakra UI 等等 UI 框架的配置。
|
|
4
|
+
|
|
5
|
+
Languages: [中文](./README.zh-CN.md) | [English](./README.md)
|
|
6
|
+
|
|
7
|
+
## 快速上手
|
|
8
|
+
|
|
9
|
+
1. 安装
|
|
10
|
+
- `npm install -D @qiqi1996/design-system`
|
|
11
|
+
- `pnpm install -D @qiqi1996/design-system`
|
|
12
|
+
- `bun add -D @qiqi1996/design-system`
|
|
13
|
+
2. 创建 `design-system.json`
|
|
14
|
+
- 注意：
|
|
15
|
+
- 你可以将 `$schema` 改为 `schema-zh.json` 或 `schema-en.json` 以查看多语言的 JSON 字段注释。（目前支持：中文、英语）
|
|
16
|
+
- 以下示例为：定义了 8px 的空间系统，和基于 Ant Design 的色板算法生成 品牌色（克莱因蓝） 色板，并将此色板应用到了 Chakra UI 的语义化命名。此设计系统配置将生成 Tailwind V4 版本的配置到 `./src-doc/src/theme.css` 文件中。
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"$schema": "./node_modules/@qiqi1996/design-system/schema-zh.json",
|
|
20
|
+
"output": {
|
|
21
|
+
"tailwind-v4": "./src-doc/src/theme.css"
|
|
22
|
+
},
|
|
23
|
+
"space": {
|
|
24
|
+
"base": 8,
|
|
25
|
+
"unit": "px"
|
|
26
|
+
},
|
|
27
|
+
"color": {
|
|
28
|
+
"palettes": [
|
|
29
|
+
{
|
|
30
|
+
"type": "monochromatic",
|
|
31
|
+
"name": "brand",
|
|
32
|
+
"base": "#002FA7"
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"semantic": {
|
|
36
|
+
"primary": {
|
|
37
|
+
"default": {
|
|
38
|
+
"solid": "brand-600"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
3. 执行生成：qi-design-system --config /path/to/your/design-system.json
|
|
46
|
+
|
|
47
|
+
## 特性和计划
|
|
48
|
+
|
|
49
|
+
### 颜色系统定义
|
|
50
|
+
|
|
51
|
+
- [ ] 颜色系统
|
|
52
|
+
- [ ] 单色色板生成
|
|
53
|
+
- [x] Ant Design Color
|
|
54
|
+
- [ ] Mantine Colors Generator
|
|
55
|
+
- [ ] 三元群配色方案
|
|
56
|
+
- [x] 语义化（基于 Chakra UI Semantic 定义）
|
|
57
|
+
- [ ] 暗黑模式
|
|
58
|
+
- [ ] 字体系统
|
|
59
|
+
- [x] 字号（仅语义化定义）
|
|
60
|
+
- [x] 行高
|
|
61
|
+
- [x] 线性自动生成
|
|
62
|
+
- [x] 字重（仅语义化定义）
|
|
63
|
+
- [x] 空间系统
|
|
64
|
+
- [ ] 圆角
|
|
65
|
+
- [ ] 阴影
|
|
66
|
+
|
|
67
|
+
### 内置配置生成器
|
|
68
|
+
|
|
69
|
+
- [x] Talwind V4
|
|
70
|
+
- [ ] Talwind V3
|
|
71
|
+
- [ ] Ant Design
|
|
72
|
+
- [ ] Chakra UI
|
|
73
|
+
- [ ] Mantine
|
|
74
|
+
|
|
75
|
+
## 贡献
|
|
76
|
+
|
|
77
|
+
* 需要 Bun 运行环境（v1.3.0+）
|