Skip to main content

Das Theme-Manifest

Jedes Theme verfügt auf der obersten Ebene über eine theme.json-Datei. Darin wird das Theme benannt, angegeben, für welche Version des Theme-Vertrags es geschrieben wurde, und seine Optionen aufgelistet.

{
    "name": "Acme Docs",
    "version": "1.0.0",
    "author": "Acme Inc.",
    "contract": "^1.0",
    "options": [
        {
            "key": "accent",
            "type": "color",
            "label": "Accent color",
            "description": "Links, buttons and the portal banner.",
            "default": "#3a46e8"
        }
    ],
    "i18n": { "sourceLanguage": "en" }
}

Feld

Erforderlich

Beschreibung

name

Ja

Der Name des Themes. Er wird im Namen der heruntergeladenen ZIP-Datei verwendet.

version

Ja

Die Versionsnummer des Themes. Verwenden Sie eine Versionsnummer wie beispielsweise 1.0.0; bei jeder anderen Angabe wird eine Warnung ausgegeben.

contract

Ja

Die Versionen des Themes, mit denen das Theme kompatibel ist. Verwenden Sie "^1.0"“.

author

Nein

Wer hat das Design erstellt?

options

Nein

Die Einstellungen, die das Theme im Layout-Editor bietet. Siehe Referenz zu den Designoptionen.

i18n

Nein

sourceLanguage bezeichnet die Übersetzungsdatei, die verwendet wird, wenn für einen Text keine Übersetzung in der Sprache der Seite vorliegt. Der Standardwert ist en. Siehe Ein Theme übersetzen.

Der Vertrag

Der Theme-Vertrag ist die Gesamtheit der Variablen, Funktionen und Regeln, die Paligo den Vorlagen zur Verfügung stellt, wie in diesem Abschnitt beschrieben. Die aktuelle Version ist 1.0. Das Feld contract gibt an, mit welchen Versionen Ihr Theme kompatibel ist, sodass eine spätere, inkompatible Version des Vertrags ein veröffentlichtes Theme nicht unbrauchbar machen kann.

Verwenden Sie "^1.0", was jede 1.x-Version bedeutet. Folgende Schreibweisen werden ebenfalls akzeptiert:

Formular

Bedeutet

"1.0"

Genau 1,0

"^1.0" oder "^1"

Jede 1.x-Version

"~1.0"

Jede Version 1.0.x

"1.x"

Jede 1.x-Version

"*"

Jede Version

"^1.0 || ^2.0"

Beliebiger Bereich

Vergleiche wie ">=1.0" werden nicht akzeptiert.