32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# Style Preview Images
|
||
|
||
> Images show the current snapshot-driven source build. Historical release archives retain their original templates and are not replaced by these screenshots.
|
||
|
||
Place theme style screenshots of **Desktop** in PNG format here, captured from the [local preview](../../preview/index.html).
|
||
|
||
## Naming Convention
|
||
|
||
```
|
||
horizon.png terminal.png ember.png bloom.png heritage.png
|
||
neon.png mono.png terra.png ink.png aurora.png
|
||
```
|
||
|
||
## Image Size Requirements
|
||
|
||
To ensure screenshots can be displayed in the README, please follow these size requirements:
|
||
|
||
- **Maximum:** 50 KiB per image
|
||
- **Recommended:** 10–20 KiB
|
||
- **Format:** PNG, optimised — run through `pngquant` or `optipng` before committing
|
||
|
||
## How to Capture
|
||
|
||
1. Start the dev server: `cd tools && go run . dev` and open http://127.0.0.1:3456 in your browser
|
||
2. For each style, select the **"Register Notify"** template and **"Modern"** view, **"en-US"** language and **"Desktop"** viewport; close the floating inspector
|
||
3. Take a screenshot of the rendered email (600px width recommended)
|
||
4. Save as `<style-name>.png` in this directory
|
||
|
||
> For a source clone, run `cd tools && go run . preview all`, return to the repository root, then open `preview/index.html` directly.
|
||
|
||
For automated capture, install the optional dependencies in `tools/qa` and run `node preview.cjs --update-gallery` there. Set `BROWSER_EXECUTABLE_PATH` when using an installed Chrome/Edge instead of Playwright's bundled Chromium.
|