127 lines
5.4 KiB
Markdown
127 lines
5.4 KiB
Markdown
# Gitea 邮件模板
|
||
<!-- DOC-TAGS: {"TRACKER":["LATEST-TESTED","UPSTREAM"],"RELEASE":["HEADER","SUMMARY"]} -->
|
||
|
||
为自托管 [Gitea](https://about.gitea.com) 提供精心设计、可直接部署的多风格邮件模板。
|
||
|
||
<!-- RELEASE:HEADER -->
|
||
> 最新发布版：[v28.0.0](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/latest)
|
||
<!-- /RELEASE:HEADER -->
|
||
|
||
---
|
||
|
||
## 设计理念
|
||
|
||
大多数自托管 Gitea 实例使用默认的纯文本邮件模板。本项目提供了**开箱即用、视觉精美的替代方案**——每种方案都针对特定社区或受众设计，您可以选择最适合您用户的风格。
|
||
|
||
`main` 分支中的模板可直接替换 Gitea 内置邮件模板，**无需补丁、插件或 fork**。使用已发布的压缩包前，请先查看[兼容性说明](../COMPATIBILITY.md)，了解旧版本的限制。
|
||
|
||
---
|
||
|
||
## 风格画廊
|
||
|
||
| 预览 | 风格 | 受众 | 特点 |
|
||
|---|---|---|---|
|
||
|  | **Horizon** | 企业/公司 | 蓝色强调色、石板灰排版、居中卡片 |
|
||
|  | **Terminal** | 开发者/技术 | 暗色模式、等宽字体、绿色命令行风格 |
|
||
|  | **Ember** | 社区/开源 | 暖琥珀色、圆角、人文主义、包容 |
|
||
|  | **Bloom** | 创意/初创 | 磨砂玻璃、柔和蓝色光线、虹彩点缀 |
|
||
|  | **Heritage** | 教育/研究 | 海军蓝与金色、衬线字体、经典、权威 |
|
||
|  | **Neon** | 游戏/Web3/创意科技 | 赛博朋克霓虹、粉红与青色、合成波能量 |
|
||
|  | **Mono** | 设计工作室/编辑 | 瑞士粗野主义、黑白红强调、零圆角 |
|
||
|  | **Terra** | 可持续/健康 | 温暖大地色调、有机质感、人文衬线 |
|
||
|  | **Ink** | 出版/新闻/文学 | 编辑印刷、深蓝与金色、报纸排版 |
|
||
|  | **Aurora** | 高端SaaS/正念 | 空灵光效渐变、深紫与青绿、大气光晕 |
|
||
|
||
> 图片为 600px 宽截图，来自[本地预览](../preview/index.html)。截图方法参见 [images/README.md](images/README.md)。
|
||
|
||
[**本地预览画廊**](../preview/index.html) — 先按下文生成预览数据，再在浏览器中打开。
|
||
|
||
---
|
||
|
||
## 安装
|
||
|
||
选择一种风格，将 `mail/` 目录复制到 Gitea 自定义模板路径：
|
||
|
||
```bash
|
||
cp -r themes/horizon/mail/* /var/lib/gitea/custom/templates/mail/
|
||
systemctl restart gitea
|
||
```
|
||
|
||
切换风格只需覆盖文件，无需更改配置。
|
||
|
||
`GITEA_CUSTOM` 决定自定义目录；常见路径为 Linux 二进制部署的 `/var/lib/gitea/custom`、Docker 的 `/data/gitea`，以及 Windows 的 `C:\gitea\custom`。
|
||
|
||
### 确认生效
|
||
|
||
管理后台的测试邮件不会使用自定义模板。要验证模板是否生效，请触发一次真实的
|
||
邮件通知。最快的方式是密码重置：退出登录，点击登录页的**"忘记密码"**，查看
|
||
重置邮件即可——它将使用你的自定义样式渲染。
|
||
|
||
---
|
||
|
||
## 预览
|
||
|
||
从源码克隆时，需先生成被忽略的 `preview/rendered.js`。现有 v28.0.0 及更早的压缩包未包含预览文件和画廊截图；更新后的打包流程会在后续构建中加入两者。
|
||
|
||
**静态模式：**
|
||
|
||
```bash
|
||
cd tools
|
||
go run . preview all
|
||
cd ..
|
||
```
|
||
|
||
然后在浏览器中打开 `preview/index.html`，无需启动服务器。
|
||
|
||
**开发服务器（实时重载）：**
|
||
|
||
```bash
|
||
cd tools
|
||
go run . dev
|
||
# 在浏览器中打开 http://localhost:3456
|
||
```
|
||
|
||
| 功能 | 静态 | Dev |
|
||
|-----------|--------|-----|
|
||
| Go 模板渲染 | [YES] | [YES] |
|
||
| 主题/模板切换 | [YES] | [YES] |
|
||
| 实时重载 | [NO] | [YES] |
|
||
|
||
预览支持主题与模板切换、Modern/Source 视图、桌面/移动端尺寸以及模板参数面板。`←→` 可切换选择框，`↑↓` 可切换选项，`d`/`m` 可切换视口。
|
||
|
||
---
|
||
|
||
## 兼容性
|
||
|
||
- **Gitea 28.0.0** — 使用模板发布版 v28.0.0；旧版 Gitea 请选用对应的旧版模板
|
||
<!-- TRACKER:LATEST-TESTED -->
|
||
- **最新测试：** Gitea 28.0.0
|
||
<!-- /TRACKER:LATEST-TESTED -->
|
||
<!-- RELEASE:SUMMARY -->
|
||
- **最新发布版：** [v28.0.0](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/latest)
|
||
<!-- /RELEASE:SUMMARY -->
|
||
- Gitea 1.25.0–1.27.3 请使用 [v1.27.3](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v1.27.3)；各版本限制参见[兼容性说明](../COMPATIBILITY.md)。
|
||
<!-- TRACKER:UPSTREAM -->
|
||
- **上游 Gitea 28.1.0：** [PENDING]
|
||
<!-- /TRACKER:UPSTREAM -->
|
||
- 当前源码使用 Gitea 官方模板的数据路径；各发布版的限制详见 [兼容性说明](../COMPATIBILITY.md)
|
||
|
||
## 模板类型
|
||
|
||
每种风格都提供 11 种邮件类型：账户激活、邮箱验证、注册通知、密码重置、团队邀请、仓库协作者、仓库转移、新版发布、Actions 工作流、议题/合并请求指派及议题/合并请求更新。具体文件路径参见[英文 README](../README.md#template-types)。
|
||
|
||
## 设计与翻译
|
||
|
||
模板采用适合邮件客户端的响应式布局，并提供按钮失效时可用的备用链接。通知正文使用 Gitea 的翻译系统；部分主题装饰性标签仍为英文，并非所有可见文字都已本地化。
|
||
|
||
## 文档与贡献
|
||
|
||
- [English README](../README.md)
|
||
- [简体中文 README](README.zh-CN.md)
|
||
- [English CONTRIBUTING](../CONTRIBUTING.md)
|
||
- [简体中文贡献指南](CONTRIBUTING.zh-CN.md)
|
||
|
||
## 许可证
|
||
|
||
MIT — 详见 [LICENSE](../LICENSE)。
|