Skip to content

Commit 6f9eedb

Browse files
committed
docs update readme
1 parent 6a0d7bd commit 6f9eedb

File tree

4 files changed

+122
-122
lines changed

4 files changed

+122
-122
lines changed

README.en.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,89 @@
11
# Element Plus Theme Editor
22

3-
[English](README.en.md) | 简体中文
3+
English | [简体中文](README.zh.md)
44

5-
Element Plus 主题变量编辑工具,帮助设计师快速调整和预览 Element Plus 组件的主题样式。
5+
A theme variable editor for Element Plus component library, helping designers quickly adjust and preview Element Plus component styles.
66

7-
## 项目背景
7+
## Project Background
88

9-
本项目旨在解决设计人员频繁更换配色主题的问题。通过提供可视化的主题编辑工具,让设计师能够自主调整主题变量并导出配置,减少开发人员的工作负担。
9+
This project aims to solve the problem of frequent theme changes by designers. By providing a visual theme editing tool, designers can independently adjust theme variables and export configurations, reducing the workload of developers.
1010

11-
## 技术栈
11+
## Tech Stack
1212

1313
- Vue 3
1414
- TypeScript
1515
- Tailwind CSS
1616
- Element Plus
1717

18-
## 功能特性
18+
## Features
1919

20-
### 1. 主题变量编辑
20+
### 1. Theme Variable Editing
2121

22-
左侧为变量编辑区,右侧为组件展示区。支持以下类型的变量编辑:
22+
The interface is divided into two sections: variable editing area on the left and component preview area on the right. Supports editing of the following variable types:
2323

24-
- 颜色变量
25-
- 尺寸变量
26-
- 风格变量
27-
- 其他变量
24+
- Color variables
25+
- Size variables
26+
- Style variables
27+
- Other variables
2828

29-
![变量编辑展示](docs/imgs/变量编辑.png)
29+
![Variable Editing Preview](docs/imgs/变量编辑.png)
3030

31-
### 2. 实时预览
31+
### 2. Real-time Preview
3232

33-
编辑变量后,右侧组件区域会实时应用新的主题样式,方便设计师直观地查看效果。
33+
After editing variables, the component area on the right will immediately apply the new theme styles, allowing designers to intuitively view the effects.
3434

35-
### 3. 黑白主题切换
35+
### 3. Light/Dark Theme Toggle
3636

37-
支持在亮色和暗色主题之间快速切换,方便设计师在不同场景下预览效果。
37+
Supports quick switching between light and dark themes, making it convenient for designers to preview effects in different scenarios.
3838

39-
![主题切换展示](docs/imgs/主题切换.png)
39+
![Theme Toggle Preview](docs/imgs/主题切换.png)
4040

41-
### 4. 导出配置
41+
### 4. Export Configuration
4242

43-
支持将编辑后的主题变量导出为 CSS 文件,方便开发人员直接使用。
43+
Supports exporting edited theme variables as a CSS file, making it easy for developers to use directly.
4444

45-
![导出功能展示](docs/imgs/导出配置.gif)
45+
![Export Feature Preview](docs/imgs/导出配置.gif)
4646

47-
导出的css变量文件示例:
47+
The exported CSS variable file example:
4848

4949
```
5050
--el-color-primary: #FF8340;
5151
```
5252

53-
## 快速开始
53+
## Quick Start
5454

55-
### 安装依赖
55+
### Install Dependencies
5656

5757
```sh
5858
npm install
5959
```
6060

61-
### 启动开发服务器
61+
### Start Development Server
6262

6363
```sh
6464
npm run dev
6565
```
6666

67-
访问地址:http://localhost:5173/index.html#/theme/component
67+
Access URL: http://localhost:5173/index.html#/theme/component
6868

69-
### 构建生产版本
69+
### Build for Production
7070

7171
```sh
7272
npm run build
7373
```
7474

75-
## 开发相关
75+
## Development
7676

77-
### 推荐开发环境
77+
### Recommended IDE Setup
7878

79-
- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (并禁用 Vetur)
79+
- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur)
8080

81-
### 代码检查
81+
### Code Linting
8282

8383
```sh
8484
npm run lint
8585
```
8686

87-
## 许可证
87+
## License
8888

8989
[MIT](LICENSE)

README.zh.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Element Plus Theme Editor
2+
3+
[English](README.md) | 简体中文
4+
5+
Element Plus 主题变量编辑工具,帮助设计师快速调整和预览 Element Plus 组件的主题样式。
6+
7+
## 项目背景
8+
9+
本项目旨在解决设计人员频繁更换配色主题的问题。通过提供可视化的主题编辑工具,让设计师能够自主调整主题变量并导出配置,减少开发人员的工作负担。
10+
11+
## 技术栈
12+
13+
- Vue 3
14+
- TypeScript
15+
- Tailwind CSS
16+
- Element Plus
17+
18+
## 功能特性
19+
20+
### 1. 主题变量编辑
21+
22+
左侧为变量编辑区,右侧为组件展示区。支持以下类型的变量编辑:
23+
24+
- 颜色变量
25+
- 尺寸变量
26+
- 风格变量
27+
- 其他变量
28+
29+
![变量编辑展示](docs/imgs/变量编辑.png)
30+
31+
### 2. 实时预览
32+
33+
编辑变量后,右侧组件区域会实时应用新的主题样式,方便设计师直观地查看效果。
34+
35+
### 3. 黑白主题切换
36+
37+
支持在亮色和暗色主题之间快速切换,方便设计师在不同场景下预览效果。
38+
39+
![主题切换展示](docs/imgs/主题切换.png)
40+
41+
### 4. 导出配置
42+
43+
支持将编辑后的主题变量导出为 CSS 文件,方便开发人员直接使用。
44+
45+
![导出功能展示](docs/imgs/导出配置.gif)
46+
47+
导出的css变量文件示例:
48+
49+
```
50+
--el-color-primary: #FF8340;
51+
```
52+
53+
## 快速开始
54+
55+
### 安装依赖
56+
57+
```sh
58+
npm install
59+
```
60+
61+
### 启动开发服务器
62+
63+
```sh
64+
npm run dev
65+
```
66+
67+
访问地址:http://localhost:5173/index.html#/theme/component
68+
69+
### 构建生产版本
70+
71+
```sh
72+
npm run build
73+
```
74+
75+
## 开发相关
76+
77+
### 推荐开发环境
78+
79+
- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (并禁用 Vetur)
80+
81+
### 代码检查
82+
83+
```sh
84+
npm run lint
85+
```
86+
87+
## 许可证
88+
89+
[MIT](LICENSE)

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8" />
55
<link rel="icon" href="/favicon.svg" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Vite App</title>
7+
<title>Element Plus Theme Editor</title>
88
</head>
99
<body>
1010
<div id="app" class="dark:bg-background-00-dark text-text-01 dark:text-text-01-dark"></div>

0 commit comments

Comments
 (0)