Skip to content

Commit fc26f56

Browse files
author
Yuriy Kurant
authored
DEV: update screenshot support docs (#85)
Updates instructions for uploading screenshots for a theme. A follow-up change for the work done in (internal /t/169403).
1 parent f653ce8 commit fc26f56

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/05-themes-components/34-theme-screenshots.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ To add preview screenshots to your theme:
1818

1919
1. Create a folder called `screenshots` in the root directory of your theme
2020
2. Add two image files to this folder:
21-
- `light.png` - Shows your theme in light mode
22-
- `dark.png` - Shows your theme in dark mode
21+
- `light.webp` - Shows your theme in light mode
22+
- `dark.webp` - Shows your theme in dark mode
2323

2424
## Setting up the image files
2525

@@ -28,7 +28,7 @@ Your screenshot images must meet these requirements:
2828
- **Ratio**: 16:9 aspect ratio
2929
- **Dimensions**: 2560 × 1440 pixels (recommended)
3030
- **File size**: Under 1MB per image
31-
- **Format**: PNG format
31+
- **Format**: WebP, PNG, JPEG
3232

3333
> :information_source: Using the recommended dimensions ensures your screenshots look crisp on high-resolution displays while maintaining reasonable file sizes.
3434
@@ -40,7 +40,7 @@ After creating your screenshots, you need to update your theme’s `about.json`
4040
2. Add the `screenshots` array to the JSON object:
4141

4242
```json
43-
"screenshots": ["screenshots/light.png", "screenshots/dark.png"]
43+
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
4444
```
4545

4646
## Best practices for theme screenshots
@@ -58,7 +58,8 @@ When taking screenshots of your theme:
5858

5959
Keep your images under the 1MB size limit by:
6060

61-
- Using PNG optimization tools like [TinyPNG](https://tinypng.com/) or [ImageOptim](https://imageoptim.com/).
61+
- Using WebP format, as it combines the advantages of JPEG and PNG, offering more efficient compression than both.
62+
- For PNG format, using optimization tools like [TinyPNG](https://tinypng.com/) or [ImageOptim](https://imageoptim.com/).
6263
- Removing unnecessary metadata from image files.
6364
- Considering slightly reduced dimensions if needed while maintaining the 16:9 ratio.
6465

0 commit comments

Comments
 (0)