diff --git a/AGENTS.md b/AGENTS.md index 84ac64e..5dd2530 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -49,9 +49,11 @@ docs/ # Multi-language documentation ### Preview System - `preview/index.html` loads `preview/rendered.js` (pre-rendered by Go) and displays in iframes - Supports theme/template switching, client simulation (Modern/Gmail/Outlook/Raw), and viewport toggle (Desktop 1386x780 / Mobile 390x780) +- Keyboard navigation: `←→` cycles focus between Theme/Template/Client selects, `↑↓` selects within the focused dropdown, `d`/`m` toggles viewport - `REGISTRY` and `PARAMS` are auto-generated from `templates_config.json` — no manual syncing needed -- Static preview (open `index.html` directly) provides approximate client simulation -- Dev server (`go run . dev`) provides accurate rendering via Juice CSS inlining + live reload +- Static preview (open `index.html` directly) — all client modes show the same HTML; simulation warning is displayed +- Dev server (`go run . dev`) — applies Juice CSS inlining server-side, generates three `rendered.js` variants (modern/gmail/outlook) with client-specific CSS stripping; includes live reload via WebSocket +- Dev mode shows an info notice: simulation cannot 100% reproduce every email client — always verify against real clients ### Build Tool - `tools/tools.go` is the main entry point for the modular CLI diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 778d7ee..1883b66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,9 +49,10 @@ Documentation updates, preview screenshots, installation guides, and translation 2. Open `preview/index.html` directly in a browser — no server needed 3. Use the theme switcher, template selector, and client mode toggles -> Static Gmail/Outlook simulation is approximate. Use dev mode for accurate rendering. +> [!WARNING] +> Static Gmail/Outlook simulation is approximate. Use dev mode for relatively accurate rendering. -### Dev Server (Live Reload + CSS Inlining) +### Dev Server (Live Reload + CSS Inlining + Client Simulation) ```bash cd tools && go run . dev @@ -60,10 +61,13 @@ cd tools && go run . dev - Watches `themes/**/*.tmpl` — auto-rebuilds on save - Runs [Juice](https://github.com/Automattic/juice) to inline `
'+e+'