chore: streamline compatibility tracking and documentation
This commit is contained in:
1 parent
92d2ba9889
commit
23f0456622
16 files changed
+476
-259
No files matched your search
+41
-13
@@ -1,8 +1,8 @@
|
||||
# Gitea 邮件模板
|
||||
|
||||
为自托管 [Gitea](https://about.gitea.com) 实例精心设计、面向不同受众的邮件模板集合。
|
||||
为自托管 [Gitea](https://about.gitea.com) 提供精心设计、可直接部署的多风格邮件模板。
|
||||
|
||||
> **发布版 v28.0.0 — 已通过 Gitea 28.0.0 兼容性检查 — 110 个模板文件、10 种视觉风格、每种 11 种邮件类型**
|
||||
> 最新发布版:[v28.0.0](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v28.0.0)
|
||||
|
||||
---
|
||||
|
||||
@@ -29,9 +29,9 @@
|
||||
|  | **Ink** | 出版/新闻/文学 | 编辑印刷、深蓝与金色、报纸排版 |
|
||||
|  | **Aurora** | 高端SaaS/正念 | 空灵光效渐变、深紫与青绿、大气光晕 |
|
||||
|
||||
> 图片为 600px 宽截图,来自[在线预览](../preview/index.html)。截图方法参见 [images/README.md](images/README.md)。
|
||||
> 图片为 600px 宽截图,来自[本地预览](../preview/index.html)。截图方法参见 [images/README.md](images/README.md)。
|
||||
|
||||
[**在线预览画廊**](../preview/index.html)
|
||||
[**本地预览画廊**](../preview/index.html) — 先按下文生成预览数据,再在浏览器中打开。
|
||||
|
||||
---
|
||||
|
||||
@@ -46,6 +46,8 @@ systemctl restart gitea
|
||||
|
||||
切换风格只需覆盖文件,无需更改配置。
|
||||
|
||||
`GITEA_CUSTOM` 决定自定义目录;常见路径为 Linux 二进制部署的 `/var/lib/gitea/custom`、Docker 的 `/data/gitea`,以及 Windows 的 `C:\gitea\custom`。
|
||||
|
||||
### 确认生效
|
||||
|
||||
管理后台的测试邮件不会使用自定义模板。要验证模板是否生效,请触发一次真实的
|
||||
@@ -56,33 +58,59 @@ systemctl restart gitea
|
||||
|
||||
## 预览
|
||||
|
||||
从源码克隆时,需先生成被忽略的 `preview/rendered.js`。现有 v28.0.0 及更早的压缩包未包含预览文件和画廊截图;更新后的打包流程会在后续构建中加入两者。
|
||||
|
||||
**静态模式:**
|
||||
|
||||
```bash
|
||||
cd tools && go run . preview all
|
||||
cd tools
|
||||
go run . preview all
|
||||
cd ..
|
||||
```
|
||||
然后打开 `preview/index.html`。
|
||||
|
||||
然后在浏览器中打开 `preview/index.html`,无需启动服务器。
|
||||
|
||||
**开发服务器(实时重载):**
|
||||
|
||||
```bash
|
||||
cd tools && go run . dev
|
||||
# → http://localhost:3456
|
||||
cd tools
|
||||
go run . dev
|
||||
# 在浏览器中打开 http://localhost:3456
|
||||
```
|
||||
|
||||
| 功能 | 静态 | Dev |
|
||||
|-----------|--------|-----|
|
||||
| Go 模板渲染 | ✅ | ✅ |
|
||||
| 主题/模板切换 | ✅ | ✅ |
|
||||
| 实时重载 | — | ✅ |
|
||||
| Go 模板渲染 | [YES] | [YES] |
|
||||
| 主题/模板切换 | [YES] | [YES] |
|
||||
| 实时重载 | [NO] | [YES] |
|
||||
|
||||
预览支持主题与模板切换、Modern/Source 视图、桌面/移动端尺寸以及模板参数面板。`←→` 可切换选择框,`↑↓` 可切换选项,`d`/`m` 可切换视口。
|
||||
|
||||
---
|
||||
|
||||
## 兼容性
|
||||
|
||||
- **Gitea 28.0.0** — 使用模板发布版 v28.0.0;旧版 Gitea 请选用对应的旧版模板
|
||||
- **最新测试:** Gitea 28.0.0<!-- TRACKER:LATEST-TESTED -->
|
||||
- **最新发布版:** [v28.0.0](https://github.com/KenanZhu/GiteaMailTemplates/releases/tag/v28.0.0) 已将全部 10 个主题的发布通知适配为 `FormatByteSize`;Gitea 1.25.0–1.27.3 请使用 [v1.27.3](https://github.com/KenanZhu/GiteaMailTemplates/releases/tag/v1.27.3)(详见[兼容性说明](../COMPATIBILITY.md))
|
||||
- **最新测试:** Gitea 28.0.0 <!-- TRACKER:LATEST-TESTED -->
|
||||
- **最新发布版:** [v28.0.0](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v28.0.0) 已将全部 10 个主题的发布通知适配为 `FormatByteSize`;Gitea 1.25.0–1.27.3 请使用 [v1.27.3](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v1.27.3)(详见[兼容性说明](../COMPATIBILITY.md))
|
||||
- **上游 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)。
|
||||
Reference in new issue
Block a user