Je leistungsfähiger Themes werden, desto mehr muss man über ihre Funktionsweise wissen. Wir haben umfangreiche, detaillierte Dokumentation unter #theme-guides, aber wenn du nur etwas brauchst, das dir den Weg weist, kann dieses Handbuch hilfreich sein.
Allgemeine Ressourcen
Einsteigerhandbuch
Handbuch für Designer
Handbuch für Entwickler
Theme Creator
Theme CLI
Theme-Verzeichnis
Komponenten-Verzeichnis
Theme-Modifizierer
Theme-fähige Site-Einstellungen
Datei-/Ordnerstruktur mehr erfahren
about.json
settings.yml
common/, desktop/, mobile/
{common|desktop|mobile}.scss
head_tag.html
header.html
after_header.html
body_tag.html
footer.html
embedded.scss (nur common)
locales/
en.yml
...
assets/
(beliebig benannte Dateien, referenziert in about.json)
stylesheets/
(beliebig benannte Dateien, können voneinander und von common/desktop/mobile.scss importiert werden)
javascripts/
(beliebig benannte Dateien. Unterstützt .js, .gjs und .hbs)
about.json Strukturinformationen, verfügbare Metadaten
{
"name": "My Theme",
"component": false,
"license_url": null,
"about_url": null,
"authors": null,
"theme_version": null,
"minimum_discourse_version": null,
"maximum_discourse_version": null,
"assets": {
"variable-name": "assets/my-asset.jpg"
},
"color_schemes": {
"My Color Scheme": {
"primary": "222222"
}
}
}
SCSS
Verfügbare CSS-VariablenJavascript mehr erfahren
// {theme}/javascripts/api-initializers/init-theme.gjs
import { apiInitializer } from "discourse/lib/api";
export default apiInitializer((api) => {
// Dein Code hier
});
Einstellungen mehr erfahren
settings.yml:
fruit:
default: apples|oranges
type: list
description: # Alte Methode. Es ist besser, diese in den Locale-Dateien zu definieren (siehe unten)
en: English Description
fr: Description Française
Zugriff aus JavaScript:
console.log(settings.fruit);
Zugriff aus gjs-Vorlagen:
<template>{{settings.fruit}}</template>
Zugriff aus scss:
html {
font-size: #{$global-font-size}px;
background: $site-background;
}
Theme-fähige Site-Einstellungen mehr erfahren
about.json:
"theme_site_settings": {
"enable_welcome_banner": false
}
Zugriff aus JavaScript:
@service siteSettings;
this.siteSettings.enable_welcome_banner;
Zugriff aus gjs-Vorlagen:
<template>{{this.siteSettings.enable_welcome_banner}}</template>
Übersetzungen mehr erfahren
locales/en.yml
en:
my_translation_key: "I love themes"
theme_metadata: # Diese werden im Admin-Panel verwendet. Sie stehen deinen js/hbs-Dateien nicht zur Verfügung
description: This theme lets you do amazing things on your Discourse
settings:
fruit: A description of the whitelisted_fruits setting
Zugriff aus JavaScript:
import { i18n } from "discourse-i18n";
i18n(themePrefix("my_translation_key"));
Zugriff aus gjs-Vorlagen:
import { i18n } from "discourse-i18n";
<template>
{{i18n (themePrefix "my_translation_key")}}
<DButton @label={{theme-prefix "my_translation_key"}} />
</template>
Dieses Dokument wird versioniert verwaltet – Vorschläge für Änderungen auf github.