Theme configuration
The configuration your theme should be specified in the file Resources/config/theme.yml. The configuration of the theme specifies values such as its name, author, etc. The settings defined in the configuration file determine what controls a content author has access to when creating a site with this theme.
note
If your theme will be available to Galaxies sites, add a 'theme-demo' route to your theme bundle. This route is used by the galaxy designer to provide a preview of your theme.
Configuration options
| Option | Description | Required? |
|---|---|---|
| name | The name of the theme | yes |
| main-site | Whether the theme is for the main site | no |
| author | The developer or organisation that created the theme | no |
| description | A textual description of the theme. Note: this isn't shown within the Control Center interface | no |
| screenshot | File path of the preview of the theme bundle | yes |
| settings | Customisable settings of the theme, that define how an author can change the display of the site. | no |
| credits | Other deverlopers or organisations that have produced assets used within the theme | no |
| machine-name | A machine name for the theme. It should start with a letter, and can contain alphanumeric characters and hyphens | yes |
| bundle-class-name | PSR namespace of the bundle class of the theme | yes |
| tags | A comma separated list of tags, that are used to classify the theme within the theme selection window | no |
Example theme.yml file
name: Dopetrope
author: Jadu Ltd
description: Adapted from Dopetrope by HTML5 UP.
screenshot: images/preview.png
credits:
html5up.net | @ajlkn
machine-name: jadu-dopetrope
bundle-class-name: Photon\Themes\DopetropeTheme\DopetropeThemeBundle
tags: html5, responsive