Sie können einem Theme verschiedene Metadaten hinzufügen. Einige werden in der Datei about.json gespeichert, andere in den Locale-Dateien.
about.json
Datei-Format-Infos
name (String, erforderlich): Der Standardname für das Theme bei der Installation. Administratoren können diesen nach der Installation des Themes ändern.
component (Boolean, Standard false): Gibt an, ob das Theme als Komponente behandelt werden soll.
license_url (String, optional): Eine URL für eine Lizenzdatei. In der Admin-Oberfläche wird ein Link zu dieser angezeigt. Die meisten Themes verwenden dies, um auf ihre Lizenzdatei auf GitHub zu verlinken.
about_url (String, optional): Eine URL, die weitere Informationen über das Theme enthält. In der Admin-Oberfläche wird ein Link zu dieser angezeigt. Die meisten Themes verwenden dies, um auf ihren Meta-Thread zu verlinken.
authors (String, optional): Ein String, der den Autor des Themes beschreibt. Wird in der Admin-Oberfläche angezeigt.
theme_version (String, optional): Ein beliebiger String, der die Version des Themes beschreibt. Wird in der Admin-Oberfläche angezeigt.
screenshots (Array, optional): Bis zu zwei Screenshot-Pfade, die an verschiedenen Stellen der Benutzeroberfläche zur Anzeige von Screenshots des Themes verwendet werden. Weitere Details zu Einschränkungen siehe unten.
minimum_discourse_version (String, optional): Die früheste Discourse-Version, mit der dieses Theme kompatibel ist. Wenn sie nicht übereinstimmt, wird das Theme automatisch deaktiviert. Sollte im Format 2.4.0.beta1 vorliegen.
maximum_discourse_version (String, optional): Die neueste Discourse-Version, mit der dieses Theme kompatibel ist. Wenn sie nicht übereinstimmt, wird das Theme automatisch deaktiviert. Sollte im Format 2.4.0.beta1 vorliegen.
Locale-Dateien (z. B. en.yml)
Datei-Format-Infos
theme_metadata.description: Eine lokalisierte Beschreibung des Themes. Wird in der Admin-Oberfläche angezeigt.
theme_metadata.settings.setting_name: Eine lokalisierte Beschreibung von setting_name, die unter der Theme-Einstellung im Admin-Panel angezeigt wird.
Screenshots
Themes und Komponenten können maximal zwei Screenshots im Schlüssel screenshots von about.json definieren, was ungefähr so aussehen würde:
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
Beachten Sie diese Einschränkungen:
- Screenshots müssen sich in einem Ordner namens
screenshotsim GitHub-Repository des Themes befinden - Maximale Dateigröße:
1 MB - Maximale Auflösung:
3840×2160(4K) - Empfohlenes Verhältnis:
16:9 - Zulässige Formate:
.webp,.png,.jpeg,.jpg
Wir folgen außerdem der Konvention, sowohl light- als auch dark-Screenshots einzubeziehen.
Dieses Dokument wird versioniert – schlagen Sie Änderungen auf GitHub vor.