Skip to content

Commit 2afb9eb

Browse files
author
Yuriy Kurant
authored
FEATURE: update Screenshots for theme metadata page (#84)
Updates criteria for uploading screenshots for a theme. A follow-up change for the work done in (internal `/t/169403`).
1 parent 5044ba1 commit 2afb9eb

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/05-themes-components/12-theme-metadata.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,15 @@ You can add various pieces of metadata to a theme. Some are stored in the `about
3737
Themes and components can define a _maximum of two screenshots_ in the `screenshots` key of `about.json`, which will look something like this:
3838

3939
```json
40-
"screenshots": ["screenshots/light.png", "screenshots/dark.png"]
40+
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
4141
```
4242

43-
There are several restrictions that must be considered:
43+
Keep these restrictions in mind:
4444

45-
- The screenshots must be in a folder called `screenshots` in the theme's GitHub repo
46-
- Screenshots cannot exceed 1 megabyte in size
47-
- Screenshots cannot be bigger than 3840x2160, which is 4K resolution. The recommended resolution is 2840x1860.
48-
- Screenshots can only be in jpeg, gif, or png format
45+
- Screenshots must be in a `screenshots` folder in the theme’s GitHub repo
46+
- Max file size: `1 MB`
47+
- Max resolution: `3840×2160` (4K)
48+
- Recommended ratio: `16:9`
49+
- Allowed formats: `.webp`, `.png`, `.jpeg`, `.jpg`
4950

50-
We currently have a convention to provide both a `light` and a `dark` screenshot, but at this time the `dark` screenshot is not used.
51+
We also follow a convention to include both `light` and `dark` screenshots.

0 commit comments

Comments
 (0)