Skip to content

Commit 1058cf8

Browse files
authored
Add theme directory structure and requirements to README
Added a detailed explanation of the directory structure and theme requirements, including the necessary files and metadata for each theme.
1 parent aec34eb commit 1058cf8

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Directory Structure
2+
===
3+
4+
Theme names may consist of A-Z (mixed case), 0-9 and dashes. No other characters are permitted.
5+
6+
Each theme needs to be placed within its own directory with the name of the theme. It should contain the following files:
7+
8+
ThemeName\ThemeName.css //The main theme file
9+
ThemeName\ThemeName.less //(Optional - the original if LESS is used)
10+
ThemeName\info.json //Metadata about the theme (See below)
11+
ThemeName\preview.png //A 420x350px preview of the theme based on the theme preview from within AMP
12+
13+
info.json
14+
===
15+
16+
```
17+
{
18+
"Name": "ThemeName",
19+
"Version": "1.0",
20+
"UpdatedDate": "2024/08/23",
21+
"Description": "A description of my theme,
22+
"URL": "https://example.org",
23+
"Author": "Author Name",
24+
"Tags": ["Contributor", "Example"]
25+
}
26+
```
27+
28+
`Name` is the name of the theme exactly matching the theme directory and css file name.
29+
`Version` is a semver version, this isn't currently used for anything important.
30+
`UpdatedDate` is the date the theme was updated in YYYY/MM/DD format.
31+
`Description` A user-facing description of the theme and how it looks, and who may benefit from it.
32+
`URL` is an address for the author (for example a personal website, github page, etc)
33+
`Author` is the name(s) of the author(s), comma separated if there are multiple.
34+
`Tags` is a list of user-defined tags. All third party themes must have the tag "Contributor", other tags can include things like "Dark", "Light", "Accessible", or any other tags which define the theme. These tags are used to build the top-level category lists within the store page.
35+
36+
preview.png screenshots
37+
===
38+
39+
These screenshots are shown within the store page in AMP. See the [Coffee Example](https://github.com/CubeCoders/AMPThemes/blob/main/Coffee/preview.png) for how they should look - they are obtained by previewing a theme within AMPs store and reducing the size of the preview page, and then cropping to the desired elements only.

0 commit comments

Comments
 (0)