Come build with us.
Stacks API v13 for Stacks 5.0
Theme API
Schema: A theme is a macOS-style bundle with the extension .stackstheme and these required paths:
Example.stackstheme/
└── Contents/
├── Info.plist
└── Resources/
└── Templates/
The schema identifies the following optional resource locations:
Contents/Resources/assets
Contents/Resources/Templates/theme_overrides
Contents/Resources/Templates/basic_theme_overrides
The schema does not fully describe the purpose or required contents of the two override locations. Treat them as implementation details until their behaviour is verified.
Contents/Info.plist identifies the bundle as a theme and declares metadata, controls, assets and libraries. See Theme Info.plist.
Every file in Contents/Resources/Templates may define a named template through YAML frontmatter. Template files can use any extension. The bundled themes conventionally use .html, .css and .js extensions because those extensions make the source easier to understand and edit.
Template identity comes from its frontmatter id, not its filename.
Bundled themes use:
<key>icon</key>
<string>icon</string>
and include large standard and Retina PNGs in Contents/Resources. Existing Stacks icon naming conventions should be supported when producing distributable themes.
Observed: Rename a working theme to .devstackstheme while developing it. Stacks reloads many resource changes without requiring the theme to be reinstalled.
Changes to bundle metadata or an already-instantiated theme may still require one of the following:
Do not distribute a development bundle as the finished product.
Assets are files or folders copied into published output. Libraries are named shared resources. Their plist declarations follow the same general API used by ordinary stacks; see Theme Info.plist.