theme.json

Every theme needs a theme.json to work. As mentioned before, all subdirectories of the packages directory containing a theme.json side by side with at least one template are to be considered as valid themes. Please see the list below for all required fields.

name

The name of the theme

description

A short description of the theme

author

The author's name

version

The version of the theme follwing the semantic versioning convention

license

The theme's license

tooltips

An object of tooltips for every variable used in the theme. Tooltips show up when hovering a variable's field in the dashboard when editing page data.

Example

The included Tutorial theme provides a good example for a theme.json file and can be used as template for your own project:

{
    "name": "Tutorial",
    "description": "A collection of tutorial templates",
    "author": "Marc Anton Dahmen",
    "version": "1.0.0",
    "license": "MIT",
    "tooltips": {
        "date": "Set a date to show up as post or project info",
        "email": "Your contact email address",
        "text": "The main content of the page",
        "textTeaser": "The content of the teaser section"
    }
}