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