Dokumentation zur Erweiterung von Discourse mit Plugins, Themes und Theme-Komponenten, zur Arbeit mit dem Core-Code und zur Nutzung der Discourse-API.
Einführung
- Einführung: Einführung in die Discourse-Entwicklung
Entwicklungsumgebungen
- Dev-Container: Discourse-Entwicklung mit einem Dev-Container
- GitHub Codespaces: Discourse-Entwicklung in GitHub Codespaces
- Docker-Einrichtung: Discourse für die Entwicklung mit Docker installieren
- macOS-Einrichtung: Discourse auf macOS für die Entwicklung installieren
- Ubuntu/Debian-Einrichtung: Discourse auf Ubuntu oder Debian für die Entwicklung installieren
- Windows-Einrichtung: Discourse auf Windows für die Entwicklung installieren
- Nicht-Docker-Plugins: Plugins in Ihrer Nicht-Docker-Entwicklungsumgebung installieren
- Lokale Einrichtung: Eine lokale Discourse-Entwicklungsumgebung einrichten?
- Multisite-Einrichtung: Eine Multisite-Entwicklungsumgebung einrichten
- Fedora-Einrichtung: Discourse für die Entwicklung auf Fedora Linux einrichten
Code & Interna
- Ember-Komponenten: Ember-Komponenten zu Discourse hinzufügen
- Linting & Formatierung: Code automatisch vor Commits linten und formatieren
- Akzeptanztests: Akzeptanztests und Komponententests für Ember-Code in Discourse schreiben
- Testsuiten ausführen: So führen Sie die QUnit-Testsuiten für Discourse Core, Plugins und Themes aus
- Versionskompatibilität: Plugins und Themes für ältere Discourse-Installationen auf eine bestimmte Version festlegen (d-compat-Branches)
- Eigentum an Ember-Objekten: Eigentum an Ember-Objekten (getOwner, Service-Injektionen usw.)
- JS-Leistung: Verwendung von Googles „tachometer“ zur Messung von JS-Leistungsänderungen in Discourse
- CI mit GitHub Actions: Continuous Integration mit GitHub Actions einrichten
- Markdown-Erweiterungen: Entwicklerhandbuch für Markdown-Erweiterungen
- Modals konvertieren: Konvertierung von Modals von Legacy-Controllern zur neuen DModal-Komponenten-API
- DModal-API: Verwendung der DModal-API zum Rendern von Modal-Fenstern (aka Popups/Dialoge) in Discourse
- JS-API: Verwendung der JS-API
- Plugin-Outlet-Connectors: Verwendung von Plugin-Outlet-Connectors aus einem Theme oder Plugin
- modifyClass: Verwendung von modifyClass zur Änderung des Core-Verhaltens
- Routen erstellen: Routen in Discourse erstellen und Daten anzeigen
- Authentifizierungsmethode: Eine neue „managed“-Authentifizierungsmethode zu Discourse hinzufügen
- Unabsichtliche Serialisierung von ActiveRecord-Modellen: Verhinderung der unabsichtlichen Serialisierung von ActiveRecord-Modellen
- Templates überschreiben: (nicht empfohlen) Discourse-Templates aus einem Theme oder Plugin überschreiben
- Service-Objekte: Verwendung von Service-Objekten in Discourse
- System-Specs: End-to-End-System-Specs für die Discourse-Benutzeroberfläche schreiben
- FormKit: Discourse-Toolkit zum Rendern von Formularen.
- AppEvents-Triggers: AppEvents-Triggers-Referenz
- Transformer: Verwendung von Transformern zur Anpassung clientseitiger Werte und Verhaltensweisen
- Themenlisten-Anpassung: Anpassung der Themenliste
- CSS-Richtlinien: Richtlinien für CSS-Klassen unter Verwendung von BEM
- JS-Typ-Hinweise & Validierung: JavaScript-Typ-Hinweise & Validierung (typescript)
- Design für Geräte: Design für verschiedene Geräte (Touch & Hover)
- Design für responsive Breiten: Design für responsive Breiten (Breakpoints, Viewport & Container)
Plugins
- Basis-Plugin: Entwicklung von Discourse-Plugins – Teil 1 – Ein Basis-Plugin erstellen
- Plugin-Outlet: Entwicklung von Discourse-Plugins – Teil 2 – Verbindung zu einem Plugin-Outlet
- Site-Einstellungen: Entwicklung von Discourse-Plugins – Teil 3 – Benutzerdefinierte Site-Einstellungen hinzufügen
- Git-Einrichtung: Entwicklung von Discourse-Plugins – Teil 4 – Git einrichten
- Admin-Oberfläche: Entwicklung von Discourse-Plugins – Teil 5 – Eine Admin-Oberfläche hinzufügen
- Akzeptanztests: Entwicklung von Discourse-Plugins – Teil 6 – Akzeptanztests hinzufügen
- Plugin veröffentlichen: Entwicklung von Discourse-Plugins – Teil 7 – Ihr Plugin veröffentlichen
- Neue Lokalisierungen: Eine neue Lokalisierung aus einem Plugin hinzufügen
- Chat-Integration: Einen neuen Anbieter zu discourse-chat-integration hinzufügen
- markdown-it-Erweiterung: Ein markdown-it-Extension als Discourse-Plugin verpacken
- Rails-Autoloading: Strukturierung eines Plugins für Rails-Autoloading
Themes & Komponenten
- Theme-Entwicklung: Entwicklung von Discourse-Themes & Theme-Komponenten
- Schnellreferenz: Schnellreferenz für Theme-Entwickler
- Designer-Handbuch: Designer-Handbuch zum Einstieg mit Themes in Discourse
- Theme Creator: Einstieg in Theme Creator und die Theme-CLI
- Theme-CLI: Installieren der Discourse Theme-CLI-Konsolenanwendung zur Unterstützung beim Erstellen von Themes
- Theme-Struktur: Struktur von Themes und Theme-Komponenten
- Mehrere JS-Dateien: Theme-JavaScript in mehrere Dateien aufteilen
- Mehrere SCSS-Dateien: Theme-SCSS in mehrere Dateien aufteilen
- Theme-Einstellungen: Einstellungen zu Ihrem Discourse-Theme hinzufügen
- Objekte für Theme-Einstellungen: Objekttyp für Theme-Einstellungen
- Einstellungen migrieren: Discourse-Theme-Einstellungen migrieren
- Theme-Metadaten: Metadaten und Screenshots zu einem Theme hinzufügen
- Core-Variablen: Discourse-Core-Variablen in Ihrem Theme verwenden
- Lokalisierbare Strings: Lokalisierbare Strings zu Themes und Theme-Komponenten hinzufügen
- E2E-Tests: End-to-End-Systemtests für Themes und Theme-Komponenten
- Wartung minimieren: Wartungsaufwand für Theme-Anpassungen minimieren
- Schriftgrößen: Schriftgrößen in Ihren Themes ändern
- Assets einbinden: Assets (z. B. Bilder, Schriftarten) in Themes und Komponenten einbinden
- Benutzerdefinierte Icons: Standard-SVG-Icons von Discourse durch benutzerdefinierte Icons in einem Theme ersetzen
- Dark Mode: Themes und Plugins aktualisieren, um den automatischen Dark Mode zu unterstützen
- Theme-Modifier: Theme-Modifier: Eine kurze Einführung
- Pseudo-Elemente: Text oder Bilder an beliebiger Stelle auf Ihrer Website mit CSS-Pseudo-Elementen einfügen
- Schriftart-Komponente: Eine Schriftart-Theme-Komponente erstellen und teilen
- Highlight.JS-Sprache: Eine neue Sprache für Highlight.JS über eine Theme-Komponente installieren
- Homepage-Inhalt: Benutzerdefinierten Inhalt hinzufügen, der nur auf Ihrer Homepage angezeigt wird
- Message-Format: Message-Format-Unterstützung für Lokalisierung
- Globale Icon-Änderungen: Icons global ändern
- Alternative Icons: Alternative Icons
- Wiki-Beitrags-Stil: Den Stil eines Wiki-Beitrags ändern
- Farbschema: Ein Farbschema erstellen und teilen
- Navigationsmenü: Den
navigation_menu-Abfrageparameter verwenden, um die Seitenleiste oder andere Optionen vorab anzuzeigen - Beitragsinhalts-Stile: Inhalte von Beiträgen mit eigenen Stilen anpassen
- Theme-Screenshots: Vorschau-Screenshots zu Discourse-Themes hinzufügen
- Theme-fähige Site-Einstellungen: Steuerung von Site-Einstellungen mit Themes
Allgemeine Anleitungen
- White-Labeling mobiler Apps: Aspekte, die vor der Entscheidung für das White-Labeling der Discourse Mobile Apps zu berücksichtigen sind
- Benutzerdefinierte Automatisierungen: Benutzerdefinierte Automatisierungen erstellen
- Öffentlicher Daten-Dump: Discourse Public Data Dump
- KI-Bewertungen: Discourse AI-Bewertungen ausführen
Theme-Entwickler-Tutorial
- 1 – Einführung: Theme-Entwickler-Tutorial: 1. Einführung
- 2 – Remote-Theme: Theme-Entwickler-Tutorial: 2. Erstellen eines Remote-Themes
- 3 – CSS: Theme-Entwickler-Tutorial: 3. CSS in Themes
- 4 – Outlets: Theme-Entwickler-Tutorial: 4. Verwendung von Outlets zum Einfügen und Ersetzen von Inhalten
- 5 – Komponenten: Theme-Entwickler-Tutorial: 5. Erstellen und Verwenden von Komponenten
- 6 – JS-API: Theme-Entwickler-Tutorial: 6. Verwendung der JS-API
- 7 – Fazit: Theme-Entwickler-Tutorial: 7. Zusammenfassung