Skip to content

Commit 320b780

Browse files
committed
update readme
1 parent 1dd1afe commit 320b780

17 files changed

Lines changed: 109 additions & 57 deletions

README.md

Lines changed: 55 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,7 @@ A Gitea theme that pursues GitHub style not only in colors but also in styling d
1212

1313
</h4>
1414

15-
![Dashboard](screenshots/dashboard.png)
16-
17-
> [!TIP]
18-
>
19-
> Recommend using Catppuccin file icon browser plugin together for better performance.
20-
> [web-file-explorer-icons](https://github.com/catppuccin/web-file-explorer-icons)
15+
![Dashboard](https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/dashboard.png)
2116

2217
## Version Number Explanation
2318

@@ -60,18 +55,14 @@ THEMES = gitea-auto, gitea-light, gitea-dark, github-auto, github-light, github-
6055
>
6156
> When THEMES is not set, Gitea will use all themes
6257
63-
For details, please refer to the Gitea documentation
64-
[Gitea docs](https://docs.gitea.com/next/administration/customizing-gitea#customizing-the-look-of-gitea)
65-
6658
> [!IMPORTANT]
6759
>
6860
> Automatic color theme requires both light and dark theme files.
6961
70-
### Template File Installation (Optional)
62+
For details, please refer to the Gitea documentation
63+
[Gitea docs](https://docs.gitea.com/next/administration/customizing-gitea#customizing-the-look-of-gitea)
7164

72-
1. Download the latest template files from the release page and place them in the `data/gitea/templates` directory (This
73-
directory may not be available by default and needs to be manually created)
74-
2. Restart Gitea
65+
### Template File Installation (Optional)
7566

7667
> [!IMPORTANT]
7768
>
@@ -81,6 +72,10 @@ For details, please refer to the Gitea documentation
8172
> Template layout is bound to the Gitea instance and will affect all themes, impacting the experience of other
8273
> non-project themes.
8374
75+
1. Download the latest template files from the release page and place them in the `data/gitea/templates` directory (This
76+
directory may not be available by default and needs to be manually created)
77+
2. Restart Gitea
78+
8479
### Translation File Installation (Optional)
8580

8681
> [!TIP]
@@ -94,20 +89,20 @@ For details, please refer to the Gitea documentation
9489

9590
## Screenshots
9691

97-
### Basic Themes
92+
### Default Themes
9893

9994
```ini
10095
THEMES = github-auto, github-light, github-dark, github-soft-dark
10196
```
10297

10398
<details>
104-
<summary>Base</summary>
99+
<summary>Default</summary>
105100
<h4>theme-github-light.css</h4>
106-
<img src="screenshots/light.png"/>
101+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/light.png"/>
107102
<h4>theme-github-dark.css</h4>
108-
<img src="screenshots/dark.png"/>
103+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/dark.png"/>
109104
<h4>theme-github-soft-dark.css</h4>
110-
<img src="screenshots/soft-dark.png"/>
105+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/soft-dark.png"/>
111106
</details>
112107

113108
### Colorblind Themes (Beta)
@@ -120,9 +115,40 @@ THEMES = github-tritanopia-auto, github-tritanopia-light, github-tritanopia-dark
120115
<details>
121116
<summary>Colorblind & Tritanopia</summary>
122117
<h4>theme-github-colorblind-light.css & theme-github-tritanopia-light.css</h4>
123-
<img src="screenshots/colorblind/colorblind-light.png"/>
118+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/colorblind/colorblind-light.png"/>
124119
<h4>theme-github-colorblind-dark.css & theme-github-tritanopia-dark.css</h4>
125-
<img src="screenshots/colorblind/colorblind-dark.png"/>
120+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/colorblind/colorblind-dark.png"/>
121+
</details>
122+
123+
### HighContrast Themes
124+
125+
```ini
126+
THEMES = github-high-contrast-auto, github-high-contrast-light, github-high-contrast-dark, github-high-contrast-soft-dark
127+
```
128+
129+
<details>
130+
<summary>HighContrast</summary>
131+
<h4>theme-github-high-contrast-light.css</h4>
132+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast/high-contrast-light.png"/>
133+
<h4>theme-github-high-contrast-dark.css</h4>
134+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast/high-contrast-dark.png"/>
135+
<h4>theme-github-high-contrast-soft-dark.css</h4>
136+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast/high-contrast-soft-dark.png"/>
137+
</details>
138+
139+
### HighContrast Colorblind Themes ( Beta )
140+
141+
```ini
142+
THEMES = github-high-contrast-colorblind-auto, github-high-contrast-colorblind-light, github-high-contrast-colorblind-dark
143+
THEMES = github-high-contrast-tritanopia-auto, github-high-contrast-tritanopia-light, github-high-contrast-tritanopia-dark
144+
```
145+
146+
<details>
147+
<summary>HighContrast Colorblind & Tritanopia</summary>
148+
<h4>theme-github-high-contrast-colorblind-light.css & theme-github-high-contrast-tritanopia-light.css</h4>
149+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast-colorblind/high-contrast-colorblind-light.png"/>
150+
<h4>theme-github-high-contrast-colorblind-dark.css & theme-github-high-contrast-tritanopia-dark.css</h4>
151+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast-colorblind/high-contrast-colorblind-dark.png"/>
126152
</details>
127153

128154
### Pink Themes
@@ -134,11 +160,11 @@ THEMES = github-pink-auto, github-pink-light, github-pink-dark, github-pink-soft
134160
<details>
135161
<summary>Pink</summary>
136162
<h4>theme-github-pink-light.css</h4>
137-
<img src="screenshots/pink/pink-light.png"/>
163+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/pink/pink-light.png"/>
138164
<h4>theme-github-pink-dark.css</h4>
139-
<img src="screenshots/pink/pink-dark.png"/>
165+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/pink/pink-dark.png"/>
140166
<h4>theme-github-pink-soft-dark.css</h4>
141-
<img src="screenshots/pink/pink-soft-dark.png"/>
167+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/pink/pink-soft-dark.png"/>
142168
</details>
143169

144170
### Gitea Themes
@@ -150,9 +176,9 @@ THEMES = github-gitea-auto, github-gitea-light, github-gitea-dark
150176
<details>
151177
<summary>Gitea</summary>
152178
<h4>theme-github-gitea-light.css</h4>
153-
<img src="screenshots/gitea/gitea-light.png"/>
179+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/gitea/gitea-light.png"/>
154180
<h4>theme-github-gitea-dark.css</h4>
155-
<img src="screenshots/gitea/gitea-dark.png"/>
181+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/gitea/gitea-dark.png"/>
156182
</details>
157183

158184
### Catppuccin Themes
@@ -164,13 +190,13 @@ THEMES = github-catppuccin-auto, github-catppuccin-latte, github-catppuccin-frap
164190
<details>
165191
<summary>Catppuccin</summary>
166192
<h4>theme-github-catppuccin-latte.css</h4>
167-
<img src="screenshots/catppuccin/catppuccin-latte.png"/>
193+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-latte.png"/>
168194
<h4>theme-github-catppuccin-frappe.css</h4>
169-
<img src="screenshots/catppuccin/catppuccin-frappe.png"/>
195+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-frappe.png"/>
170196
<h4>theme-github-catppuccin-macchiato.css</h4>
171-
<img src="screenshots/catppuccin/catppuccin-macchiato.png"/>
197+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-macchiato.png"/>
172198
<h4>theme-github-catppuccin-mocha.css</h4>
173-
<img src="screenshots/catppuccin/catppuccin-mocha.png"/>
199+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-mocha.png"/>
174200
</details>
175201

176202
## Custom CSS Variables

README_CN.md

Lines changed: 54 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,7 @@
1212

1313
</h4>
1414

15-
![Dashboard](screenshots/dashboard.png)
16-
17-
> [!TIP]
18-
>
19-
> 推荐搭配 Catppuccin 文件图标浏览器插件一起使用更佳
20-
> [web-file-explorer-icons](https://github.com/catppuccin/web-file-explorer-icons)
15+
![Dashboard](https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/dashboard.png)
2116

2217
## 版本号说明
2318

@@ -55,17 +50,14 @@ THEMES = gitea-auto, gitea-light, gitea-dark, github-auto, github-light, github-
5550
>
5651
> 不设置 THEMES 时, Gitea 会使用所有主题
5752
58-
详细请查看 Gitea 文档
59-
[Gitea docs](https://docs.gitea.com/next/administration/customizing-gitea#customizing-the-look-of-gitea)
60-
6153
> [!IMPORTANT]
6254
>
6355
> 自动颜色主题需要亮色和暗色的主题文件
6456
65-
### 模板文件安装 (可选)
57+
详细请查看 Gitea 文档
58+
[Gitea docs](https://docs.gitea.com/next/administration/customizing-gitea#customizing-the-look-of-gitea)
6659

67-
1. 在发布页下载最新的模板文件放入 `data/gitea/templates` 目录下 (默认可能没有此目录需手动创建)
68-
2. 重启 Gitea
60+
### 模板文件安装 (可选)
6961

7062
> [!IMPORTANT]
7163
>
@@ -74,6 +66,9 @@ THEMES = gitea-auto, gitea-light, gitea-dark, github-auto, github-light, github-
7466
>
7567
> 模板布局跟 Gitea 实例绑定, 所有主题都会生效, 会影响其他非本项目的主题的体验
7668
69+
1. 在发布页下载最新的模板文件放入 `data/gitea/templates` 目录下 (默认可能没有此目录需手动创建)
70+
2. 重启 Gitea
71+
7772
### 翻译文件安装 (可选)
7873

7974
> [!TIP]
@@ -89,20 +84,20 @@ THEMES = gitea-auto, gitea-light, gitea-dark, github-auto, github-light, github-
8984
9085
## 截图
9186

92-
### 基本主题
87+
### 默认主题
9388

9489
```ini
9590
THEMES = github-auto, github-light, github-dark, github-soft-dark
9691
```
9792

9893
<details>
99-
<summary>Base</summary>
94+
<summary>Default</summary>
10095
<h4>theme-github-light.css</h4>
101-
<img src="screenshots/light.png"/>
96+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/light.png"/>
10297
<h4>theme-github-dark.css</h4>
103-
<img src="screenshots/dark.png"/>
98+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/dark.png"/>
10499
<h4>theme-github-soft-dark.css</h4>
105-
<img src="screenshots/soft-dark.png"/>
100+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/soft-dark.png"/>
106101
</details>
107102

108103
### 色盲主题 ( Beta )
@@ -115,9 +110,40 @@ THEMES = github-tritanopia-auto, github-tritanopia-light, github-tritanopia-dark
115110
<details>
116111
<summary>Colorblind & Tritanopia (红绿色盲 & 蓝色盲)</summary>
117112
<h4>theme-github-colorblind-light.css & theme-github-tritanopia-light.css</h4>
118-
<img src="screenshots/colorblind/colorblind-light.png"/>
113+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/colorblind/colorblind-light.png"/>
119114
<h4>theme-github-colorblind-dark.css & theme-github-tritanopia-dark.css</h4>
120-
<img src="screenshots/colorblind/colorblind-dark.png"/>
115+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/colorblind/colorblind-dark.png"/>
116+
</details>
117+
118+
### 高对比度主题
119+
120+
```ini
121+
THEMES = github-high-contrast-auto, github-high-contrast-light, github-high-contrast-dark, github-high-contrast-soft-dark
122+
```
123+
124+
<details>
125+
<summary>HighContrast</summary>
126+
<h4>theme-github-high-contrast-light.css</h4>
127+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast/high-contrast-light.png"/>
128+
<h4>theme-github-high-contrast-dark.css</h4>
129+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast/high-contrast-dark.png"/>
130+
<h4>theme-github-high-contrast-soft-dark.css</h4>
131+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast/high-contrast-soft-dark.png"/>
132+
</details>
133+
134+
### 高对比度色盲主题 ( Beta )
135+
136+
```ini
137+
THEMES = github-high-contrast-colorblind-auto, github-high-contrast-colorblind-light, github-high-contrast-colorblind-dark
138+
THEMES = github-high-contrast-tritanopia-auto, github-high-contrast-tritanopia-light, github-high-contrast-tritanopia-dark
139+
```
140+
141+
<details>
142+
<summary>HighContrast Colorblind & Tritanopia (红绿色盲 & 蓝色盲)</summary>
143+
<h4>theme-github-high-contrast-colorblind-light.css & theme-github-high-contrast-tritanopia-light.css</h4>
144+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast-colorblind/high-contrast-colorblind-light.png"/>
145+
<h4>theme-github-high-contrast-colorblind-dark.css & theme-github-high-contrast-tritanopia-dark.css</h4>
146+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/high-contrast-colorblind/high-contrast-colorblind-dark.png"/>
121147
</details>
122148

123149
### 粉色主题
@@ -129,11 +155,11 @@ THEMES = github-pink-auto, github-pink-light, github-pink-dark, github-pink-soft
129155
<details>
130156
<summary>Pink</summary>
131157
<h4>theme-github-pink-light.css</h4>
132-
<img src="screenshots/pink/pink-light.png"/>
158+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/pink/pink-light.png"/>
133159
<h4>theme-github-pink-dark.css</h4>
134-
<img src="screenshots/pink/pink-dark.png"/>
160+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/pink/pink-dark.png"/>
135161
<h4>theme-github-pink-soft-dark.css</h4>
136-
<img src="screenshots/pink/pink-soft-dark.png"/>
162+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/pink/pink-soft-dark.png"/>
137163
</details>
138164

139165
### Gitea 主题
@@ -145,9 +171,9 @@ THEMES = github-gitea-auto, github-gitea-light, github-gitea-dark
145171
<details>
146172
<summary>Gitea</summary>
147173
<h4>theme-github-gitea-light.css</h4>
148-
<img src="screenshots/gitea/gitea-light.png"/>
174+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/gitea/gitea-light.png"/>
149175
<h4>theme-github-gitea-dark.css</h4>
150-
<img src="screenshots/gitea/gitea-dark.png"/>
176+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/gitea/gitea-dark.png"/>
151177
</details>
152178

153179
### Catppuccin 主题
@@ -159,13 +185,13 @@ THEMES = github-catppuccin-auto, github-catppuccin-latte, github-catppuccin-frap
159185
<details>
160186
<summary>Catppuccin</summary>
161187
<h4>theme-github-catppuccin-latte.css</h4>
162-
<img src="screenshots/catppuccin/catppuccin-latte.png"/>
188+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-latte.png"/>
163189
<h4>theme-github-catppuccin-frappe.css</h4>
164-
<img src="screenshots/catppuccin/catppuccin-frappe.png"/>
190+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-frappe.png"/>
165191
<h4>theme-github-catppuccin-macchiato.css</h4>
166-
<img src="screenshots/catppuccin/catppuccin-macchiato.png"/>
192+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-macchiato.png"/>
167193
<h4>theme-github-catppuccin-mocha.css</h4>
168-
<img src="screenshots/catppuccin/catppuccin-mocha.png"/>
194+
<img src="https://raw.githubusercontent.com/lutinglt/gitea-github-theme/assets/screenshots/catppuccin/catppuccin-mocha.png"/>
169195
</details>
170196

171197
## 自定义 CSS 变量
-270 KB
Binary file not shown.
-270 KB
Binary file not shown.
-273 KB
Binary file not shown.
-270 KB
Binary file not shown.
-278 KB
Binary file not shown.
-278 KB
Binary file not shown.

screenshots/dark.png

-278 KB
Binary file not shown.

screenshots/dashboard.png

-602 KB
Binary file not shown.

0 commit comments

Comments
 (0)