You've already forked gitea-banana-theme
主题更名为banana
This commit is contained in:
124
README.md
124
README.md
@@ -1,23 +1,6 @@
|
||||
# Gitea Banana Theme
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> 推荐搭配 Catppuccin 文件图标浏览器插件一起使用更佳
|
||||
> [web-file-explorer-icons](https://github.com/catppuccin/web-file-explorer-icons)
|
||||
|
||||
## 版本号说明
|
||||
|
||||
主题版本号与 Gitea 版本号保持一致
|
||||
|
||||
Gitea 版本号格式: `1.大版本号.小版本号`
|
||||
|
||||
Gitea 理论上小版本号变更不会修改前端布局, 所以主题的小版本号适用于所有 Gitea 大版本号相同的 Gitea 版本.
|
||||
|
||||
比如: 主题版本 `1.24.5` 适用于 Gitea 版本 `>=1.24.0` `<1.25.0`
|
||||
|
||||
仅维护项目发布中的最新的 Gitea 版本, 其他旧版本主题不接受 Issue 和 PR.
|
||||
|
||||
> 开发阶段的主题版本号格式: `1.大版本号.小版本号.时间戳`
|
||||
为 Gitea 提供一套现代化、美观的 Banana 风格主题。包含多种预设颜色方案,如基础的亮色、暗色和柔和暗色主题,以及为色盲用户设计的主题和粉色主题。主题通过 CSS 实现,并利用 Vite 和 Vanilla Extract 等工具进行构建。
|
||||
|
||||
## 安装
|
||||
|
||||
@@ -30,39 +13,110 @@ Gitea 理论上小版本号变更不会修改前端布局, 所以主题的小版
|
||||
>
|
||||
> 自动颜色主题需要亮色和暗色的主题文件
|
||||
|
||||
例: 主题文件名为 `theme-Banana-dark.css`,则添加 `Banana-dark` 到 `THEMES` 末尾
|
||||
例: 主题文件名为 `theme-banana-modern-dark.css`,则添加 `banana-modern-dark` 到 `THEMES` 末尾
|
||||
|
||||
`gitea/conf/app.ini` 例:
|
||||
|
||||
```ini
|
||||
[ui]
|
||||
THEMES = gitea-auto, gitea-light, gitea-dark, Banana-auto, Banana-light, Banana-dark, Banana-soft-dark
|
||||
THEMES = gitea-auto, gitea-light, gitea-dark, banana-modern-auto, banana-modern-light, banana-modern-dark, banana-soft-dark
|
||||
```
|
||||
|
||||
详细请查看 Gitea 文档
|
||||
[Gitea docs](https://docs.gitea.com/next/administration/customizing-gitea#customizing-the-look-of-gitea)
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **TypeScript**: 用于类型安全的 JavaScript 开发。
|
||||
- **Vite**: 构建工具,提供快速的开发和构建体验。
|
||||
- **Vanilla Extract**: 用于在 JavaScript/TypeScript 中编写 CSS 样式。
|
||||
- **Lightning CSS**: 用于 CSS 转换和优化。
|
||||
- **Linaria/WYW-in-JS**: 用于在 JavaScript 中编写 CSS。
|
||||
|
||||
## 开发指南
|
||||
|
||||
### 安装依赖
|
||||
|
||||
确保你已经安装了 Node.js 环境, 推荐使用 Node.js 20 或以上版本。
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### 开发构建
|
||||
|
||||
构建开发版本(仅构建 `DEV_THEME` 环境变量指定的主题,或默认的 `dark` 主题):
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### 生产构建
|
||||
|
||||
构建所有主题:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
构建过程会生成 CSS 文件到 `dist/` 目录。
|
||||
|
||||
### 代码检查和格式化
|
||||
|
||||
- 检查代码风格:
|
||||
|
||||
```bash
|
||||
npm run lint
|
||||
```
|
||||
|
||||
- 格式化代码:
|
||||
|
||||
```bash
|
||||
npm run format
|
||||
```
|
||||
|
||||
- 一键执行检查、格式化和构建:
|
||||
|
||||
```bash
|
||||
npm run commit
|
||||
```
|
||||
|
||||
## 截图
|
||||
|
||||

|
||||

|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎提交 Issue 和 Pull Request 来帮助改进这个项目。
|
||||
|
||||
在提交 Issue 时,请根据问题类型选择合适的模板:
|
||||
- 样式错误报告 (Style bug report)
|
||||
- 功能请求 (Feature request)
|
||||
- 核心错误报告 (Core bug report)
|
||||
- 文档报告 (Doc report)
|
||||
|
||||
在提交 Pull Request 时,请确保:
|
||||
1. 代码风格符合项目规范
|
||||
2. 添加了必要的测试
|
||||
3. 更新了相关文档
|
||||
|
||||
### 基本主题
|
||||
|
||||
```ini
|
||||
THEMES = Banana-auto, Banana-light, Banana-dark, Banana-soft-dark
|
||||
THEMES = banana-modern-auto, banana-modern-light, banana-modern-dark, banana-auto, banana-light, banana-dark, banana-soft-dark
|
||||
```
|
||||
|
||||
### 色盲主题 ( Beta )
|
||||
|
||||
```ini
|
||||
THEMES = Banana-colorblind-auto, Banana-colorblind-light, Banana-colorblind-dark
|
||||
THEMES = Banana-tritanopia-auto, Banana-tritanopia-light, Banana-tritanopia-dark
|
||||
THEMES = banana-colorblind-auto, banana-colorblind-light, banana-colorblind-dark
|
||||
THEMES = banana-tritanopia-auto, banana-tritanopia-light, banana-tritanopia-dark
|
||||
```
|
||||
|
||||
### 粉色主题
|
||||
|
||||
```ini
|
||||
THEMES = Banana-pink-auto, Banana-pink-light, Banana-pink-dark, Banana-pink-soft-dark
|
||||
THEMES = banana-pink-auto, banana-pink-light, banana-pink-dark, banana-pink-soft-dark
|
||||
```
|
||||
|
||||
## 自定义 CSS 变量
|
||||
@@ -100,23 +154,3 @@ THEMES = Banana-pink-auto, Banana-pink-light, Banana-pink-dark, Banana-pink-soft
|
||||
| --custom-user-repolist-columns | 用户页面的仓库列表列数 | 2 | 2 | 1/2 | | |
|
||||
| --custom-org-repolist-columns | 组织页面的仓库列表列数 | 1 | 1 | 1/2 | | |
|
||||
| --custom-org-userlist-columns | 组织页面的用户列表列数 | 2 | 1 | 1/2 | | |
|
||||
|
||||
## 使用开发中的主题
|
||||
|
||||
也许你会想使用开发中的主题, 而不是发布的主题
|
||||
|
||||
请确保你已经安装了 Node.js 环境, 推荐使用 Node.js 20 或以上版本
|
||||
|
||||
```bash
|
||||
git clone https://git.pandorastudio.cn/yuantao/giteam-custon-theme.git
|
||||
cd gitea-Banana-theme
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
编译完成后, 会在 `dist` 目录下生成主题文件, 你可以将主题文件放入 `gitea/public/assets/css` 目录下, 然后在
|
||||
`gitea/conf/app.ini` 中添加主题名称到 `THEMES` 末尾
|
||||
|
||||
## 贡献
|
||||
|
||||
请查看 [CONTRIBUTING](CONTRIBUTING.md)
|
||||
|
||||
Reference in New Issue
Block a user