1 Fork 0

Files

T

KenanZhuandClaude 0ad7db124a refactor(preview): remove juice/Node.js, simplify to pure Go dev server with SSE

- Delete tools/server/ (Node.js, juice, inliner.mjs, server.mjs, node_modules)
- Create tools/preview/server.go — pure Go dev server with SSE + file polling
- Rewrite tools/cli/dev.go — start Go server in-process, no Node.js required
- Simplify preview/index.html — View dropdown (Modern/Source), remove Client
  Simulation panel, remove Gmail/Outlook logic, WebSocket → SSE
- Update all 14 documentation files (README, CONTRIBUTING, AGENTS + translations)
  to reflect pure Go dev server and simplified preview

Co-Authored-By: Claude <noreply@anthropic.com>

2026-06-23 09:48:04 +08:00

2.6 KiB

Raw Permalink Blame History

贡献指南 — Gitea 邮件模板

参与方式

添加新风格

使用工具脚手架：cd tools && go run . create <风格名称> — 这会创建完整的目录结构和全部 11 种邮件类型的占位 .tmpl 文件
在 themes/<风格名称>/ 中编写每个 .tmpl 文件，应用独特的视觉设计
重新生成预览：cd tools && go run . preview all（构建脚本会自动发现 themes/ 下的所有主题目录并动态生成主题选择器）
提交包含截图渲染效果的 PR（单张图片 ≤ 50 KiB，建议 10–20 KiB）

风格指南

每个风格必须包含全部 11 种模板类型
只使用 Gitea 内置模板函数
翻译键必须来自 Gitea 官方语言文件（mail.* 命名空间）
不要在以下模板中使用 .DisplayName：collaborator、transfer、release、workflow_run、assigned、default
面向 600px 宽度的邮件客户端设计
尽可能在 Gmail、Outlook、Apple Mail 中测试

报告 Bug

检查引用的 Go 模板变量是否存在
验证翻译键是否与 Gitea 语言文件匹配
确认 .DisplayName 未在不支持的模板中使用
重新生成预览：cd tools && go run . preview all
提交 issue，注明风格名称、邮件类型及错误描述

改进文档

文档改进、预览截图、安装指南和翻译始终欢迎。

开发环境

Go 1.21+ 用于模板渲染和 CLI 工具

本地预览（静态）

先生成预览数据：cd tools && go run . preview all
在浏览器中打开 preview/index.html — 无需服务器

开发服务器（实时重载）

cd tools && go run . dev
# → http://localhost:3456

修改 .tmpl 文件后自动重建并推送至浏览器。

集成测试

将模板部署到 Gitea 实例后，请通过真实的邮件通知进行验证。管理后台的测试邮件（Site Administration > Configuration > Mailer > Send Test Email）不会使用自定义邮件模板——它走的是内置代码路径。

最可靠的验证方式是触发一次真实的邮件通知，推荐使用密码重置流程：

退出登录，点击登录页的**"忘记密码"**
输入账户邮箱并提交
查看密码重置邮件——它将使用你的自定义邮件模板渲染

提交规范

style(<名称>): — 特定风格的模板变更
preview: — 预览工具变更
tools: — Go 构建脚本变更
docs: — 文档和翻译
fix: — Bug 修复
project: — README、LICENSE、元文件

许可协议

参与贡献即表示您同意将您的贡献以 MIT 许可证授权。

2.6 KiB Raw Permalink Blame History Unescape Escape