1 Fork 0

Files

T

KenanZhu d8a714b2b5 feat(preview): cross-browser scrollbar, keyboard nav, dev-mode client simulation, docs overhaul

preview/index.html:
- Fix scrollbar CSS: scoped webkit pseudo-elements + standards-track fallback, removed deprecated overflow:overlay
- Keyboard navigation: arrows cycle focus between Theme/Template/Client selects, up/down select within focused dropdown, d/m toggle viewport
- Dev/static mode detection: delayed static warning only when WebSocket absent, WebSocket errors only on disconnect (not on initial fail)
- iframe sandbox: removed static sandbox attr, applied dynamically only in dev mode (file: protocol rejects sandboxed srcdoc)
- Loading fix: removed double-toggle between init and render(); added 5s safety timeout
- Transform clean: returns HTML as-is; CSS stripping moved to server-side
- Dev disclaimer: blue info banner shown on WebSocket connect

tools/server/inliner.mjs:
- Added stripGmail() / stripOutlook() — server-side CSS property stripping for email client simulation

tools/server/server.mjs:
- Fixed WebSocket upgrade: use app.listen() instead of createServer(app).listen()
- Juice post-processing now generates three rendered.js variants (modern/gmail/outlook)
- Initial startup runs juice-only pass (avoids duplicate Go compilation)

docs/ (all 6 languages — en, zh-CN, zh-TW, ja, ko, ru):
- Image size limits: max 50KiB, recommended 10-20KiB
- Dev disclaimer: simulation cannot 100% reproduce every client
- Changed 'accurate' to 'relatively accurate' across all static-mode warnings
- Converted all plain blockquotes to GitHub admonitions ([!WARNING] / [!NOTE])

2026-06-04 16:01:42 +08:00

2.6 KiB

Raw 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 工具
Node.js 18+（可选）用于实时开发服务器与 Juice CSS 内联

本地预览（静态）

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

Warning

静态 Gmail/Outlook 模拟仅供参考，使用 dev 模式可获得相对准确的 CSS 内联渲染。

开发服务器（实时重载 + CSS 内联 + 客户端模拟）

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

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

Note

Dev 模拟无法 100% 还原各个邮件客户端的渲染差异，仅供参考，请以实际效果为准。

集成测试

将模板部署到 Gitea 实例，使用管理后台的测试邮件功能： Site Administration > Configuration > Mailer > Send Test Email

提交规范

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

许可协议

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

2.6 KiB Raw Blame History Unescape Escape