update README

This commit is contained in:
lutinglt
2025-08-10 22:43:39 +08:00
parent dc4eff2bd7
commit 780c72919d
13 changed files with 55 additions and 24 deletions

View File

@@ -1,13 +1,23 @@
# gitea-github-theme
尽量保持与 GitHub 相同样式的 Gitea 主题
一个精致模仿 Github 风格的 Gitea 主题
### 主题说明
> [!TIP]
>
> 推荐搭配文件图标浏览器插件一起使用更佳
> [web-file-explorer-icons](https://github.com/catppuccin/web-file-explorer-icons)
添加了短暂的过渡动画优化体验(与 GitHub Code 克隆列表动画一致)
## 版本号说明
推荐搭配文件图标浏览器插件一起使用更佳
[github-file-explorer-icons](https://github.com/catppuccin/github-file-explorer-icons)
本主题版本号格式: `Gitea 版本号.时间戳`
Gitea 版本号格式: `1.大版本号.小版本号`
Gitea 理论上小版本号变更不会修改前端布局, 所以本主题的小版本号适用于所有 Gitea 大版本号相同的 Gitea 版本.
比如: 本主题版本 `1.24.4` 适用于 Gitea 版本 `>=1.24.0` ~ `<1.25.0`
本主题仅维护本主题发布中的最新的 Gitea 版本, 其他旧版本主题不接受 Issue 和 PR.
## 安装
@@ -15,7 +25,10 @@
2. 修改 `gitea/conf/app.ini`,并将 CSS 文件名去掉 `theme-` 的名称附加到 `[ui]` 下的 `THEMES` 末尾
3. 重启 Gitea
4. 在设置中查看主题
5. 自动颜色主题需要亮色和暗色的主题文件
> [!IMPORTANT]
>
> 自动颜色主题需要亮色和暗色的主题文件
例: 主题文件名为 `theme-github-dark.css`,则添加 `github-dark``THEMES` 末尾
@@ -65,20 +78,38 @@ THEMES = gitea-auto, gitea-light, gitea-dark, github-auto, github-light, github-
## 截图
![仓库](screenshots/repo.png)
<details open>
<summary>GitHub</summary>
<h4>亮色:</h4>
<img src="screenshots/light.png"/>
<h4>暗色:</h4>
<img src="screenshots/dark.png"/>
<h4>柔和暗色:</h4>
<img src="screenshots/soft-dark.png"/>
</details>
![仓库文件列表](screenshots/file_list.png)
![仓库发布](screenshots/release.png)
<details>
<summary>其他主题</summary>
等待贡献者ing...
</details>
![仓库提交](screenshots/commit.png)
## 使用开发中的主题
![Actions](screenshots/actions.png)
也许你会想使用开发中的主题, 而不是发布的主题
![Action](screenshots/action.png)
请确保你已经安装了 Node.js 环境, 推荐使用 Node.js 20 或以上版本
```bash
git clone https://github.com/lutinglt/gitea-github-theme.git
cd gitea-github-theme
npm install
npm run build
```
编译完成后, 会在 `dist` 目录下生成主题文件, 你可以将主题文件放入 `gitea/public/assets/css` 目录下, 然后在 `gitea/conf/app.ini` 中添加主题名称到 `THEMES` 末尾
![Dispatch](screenshots/dispatch.png)
## 贡献
欢迎提交 Issue 或 Pull Request
请查看 [CONTRIBUTING](CONTRIBUTING.md)