Dokumentation zur Erweiterung von Discourse mit Plugins, Themes und Theme-Komponenten, zur Arbeit mit dem Core-Code sowie zur Nutzung der Discourse-API.
Einführung
- Einführung: Einführung in die Discourse-Entwicklung
Entwicklungsumgebungen
- Dev Container: Entwicklung von Discourse mit einem Dev Container
- GitHub Codespaces: Entwicklung von Discourse auf GitHub Codespaces
- Docker-Setup: Discourse für die Entwicklung mit Docker installieren
- macOS-Setup: Discourse auf macOS für die Entwicklung installieren
- Ubuntu/Debian-Setup: Discourse auf Ubuntu oder Debian für die Entwicklung installieren
- Windows-Setup: Discourse auf Windows für die Entwicklung installieren
- Non-Docker-Plugins: Plugins in deiner Non-Docker-Entwicklungsumgebung installieren
- Lokales Setup: Eine lokale Discourse-Entwicklungsumgebung einrichten?
- Multisite-Setup: Eine Multisite-Entwicklungsumgebung einrichten
- Fedora-Setup: Discourse auf Fedora Linux für die Entwicklung einrichten
Code & Interna
- Ember-Komponenten: Ember-Komponenten zu Discourse hinzufügen
- UI-Kit: Das UI-Kit mit gemeinsamen Discourse-Komponenten, Helpers und Modifiern
- Linting und Formatierung: Code automatisch vor Commits linten und formatieren
- Akzeptanztests: Akzeptanztests für Ember-Code in Discourse schreiben
- Test-Suites ausführen: So führe ich die QUnit-Test-Suites von Discourse Core, Plugins und Themes aus
- Versionskompatibilität: Plugin- und Theme-Versionen für ältere Discourse-Installationen pinnen (d-compat-Branches)
- Eigentum von Ember-Objekten: Eigentum von Ember-Objekten (getOwner, Service-Injektion etc.)
- JS-Performance: Googles „tachometer“ zur Messung von JS-Performance-Änderungen in Discourse verwenden
- CI mit GitHub Actions: Continuous Integration mit GitHub Actions einrichten
- Markdown-Erweiterungen: Entwicklerhandbuch für Markdown-Erweiterungen
- Konvertierung von Modals: Konvertierung von Modals von Legacy-Controllern zur neuen DModal-Komponenten-API
- DModal-API: Die DModal-API zum Rendern von Modal-Fenstern (auch Popups/Dialoge) in Discourse verwenden
- JS-API: Die JS-API verwenden
- Plugin-Outlet-Connector: Plugin-Outlet-Connectors aus einem Theme oder Plugin verwenden
- modifyClass: modifyClass zum Ändern des Core-Verhaltens verwenden
- Erstellen von Routen: Erstellen von Routen in Discourse und Anzeigen von Daten
- Authentifizierungsmethode: Eine neue „managed“-Authentifizierungsmethode zu Discourse hinzufügen
- Versehentliches Serialisieren von ActiveRecord-Modellen: Vermeiden des versehentlichen Serialisierens von ActiveRecord-Modellen
- Überschreiben von Templates: (nicht empfohlen) Discourse-Templates aus einem Theme oder Plugin überschreiben
- Service-Objekte: Service-Objekte in Discourse verwenden
- 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: Transformer zum Anpassen von Client-seitigen Werten und Verhalten verwenden
- Anpassung der Themenliste: Die Themenliste anpassen
- CSS-Richtlinien: Richtlinien für CSS-Klassen mit BEM
- JS-Typ-Hints & Validierung: JavaScript-Typ-Hints & 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)
- Gesten-Primitives: Drag-, Resize- und Geste-Primitives
- Bundle-Splitting: Bundle-Splitting für Plugins
- Private Module: Private Module und die
-internals-Konvention - Komponententests: Komponententests für Discourse schreiben
Plugins
- Grundlegendes Plugin: Entwicklung von Discourse-Plugins – Teil 1 – Ein grundlegendes Plugin erstellen
- Plugin-Outlet: Entwicklung von Discourse-Plugins – Teil 2 – Mit einem Plugin-Outlet verbinden
- Site-Einstellungen: Entwicklung von Discourse-Plugins – Teil 3 – Eigene Site-Einstellungen hinzufügen
- Git-Setup: 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 – Dein Plugin veröffentlichen
- Neue Locales: Ein neues Locale aus einem Plugin hinzufügen
- Chat-Integration: Einen neuen Provider zu discourse-chat-integration hinzufügen
- markdown-it-Erweiterung: Eine markdown-it-Erweiterung als Discourse-Plugin neu verpacken
- Rails-Autoloading: Ein Plugin für Rails-Autoloading strukturieren
Themes & Komponenten
- Themes entwickeln: Discourse-Themes & Theme-Komponenten entwickeln
- Kurzübersicht: Kurzübersicht für Theme-Entwickler
- Handbuch für Designer: Handbuch für Designer – Einstieg in Themes in Discourse
- Theme Creator: Erste Schritte mit Theme Creator und der Theme CLI
- Theme CLI: Die Discourse Theme CLI-Console-App installieren, um dir beim Erstellen von Themes zu helfen
- 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 deinem 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 deinem Theme verwenden
- Lokalisierbare Strings: Lokalisierbare Strings zu Themes und Theme-Komponenten hinzufügen
- E2E-Testen: End-to-End-Systemtesting für Themes und Theme-Komponenten
- Wartungsaufwand minimieren: Wartungsaufwand bei Theme-Anpassungen minimieren
- Schriftgrößen: Schriftgrößen in deinen Themes ändern
- Assets einbinden: Assets (z. B. Bilder, Schriftarten) in Themes und Komponenten einbinden
- Eigene Icons: Discourses Standard-SVG-Icons in einem Theme durch eigene Icons ersetzen
- Dark Mode: Themes und Plugins für die Unterstützung des automatischen Dark Modes aktualisieren
- Theme-Modifier: Theme-Modifier: Eine kurze Einführung
- Pseudoelemente: Text oder Bilder überall auf deiner Website mit CSS-Pseudoelementen 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
- Startseiten-Inhalt: Eigene Inhalte hinzufügen, die nur auf deiner Startseite erscheinen
- Message-Format: Unterstützung für das Message-Format zur Lokalisierung
- Globale Icon-Änderungen: Icons global ändern
- Alternative Icons: Alternative Icons
- Stil eines Wiki-Posts: Den Stil eines Wiki-Posts ändern
- Farbschema: Ein Farbschema erstellen und teilen
- Navigationsmenü: Den
navigation_menu-Query-Parameter verwenden, um die Seitenleiste oder andere Optionen anzusehen - Stil für Post-Inhalte: Post-Inhalte mit deinen eigenen Stilen anpassen
- Theme-Screenshots: Vorschau-Screenshots zu Discourse-Themes hinzufügen
- Theme-fähige Site-Einstellungen: Site-Einstellungen mit Themes steuern
Allgemeine Anleitungen
- White-Labeling mobiler Apps: Was zu bedenken ist, bevor du dich entscheidest, die Discourse-Mobile-Apps als White-Label anzubieten
- Eigene Automationen: Eigene Automationen erstellen
- Öffentlicher Daten-Dump: Discourse Public Data Dump
- AI-Evals: Discourse AI-Evals ausführen
- AI-Bot über API: Den AI-Bot über die Discourse-API verwenden
Theme-Dev-Tutorial
- 1 – Einführung: Theme-Entwickler-Tutorial: 1. Einführung
- 2 – Remote Theme: Theme-Entwickler-Tutorial: 2. Ein Remote Theme erstellen
- 3 – CSS: Theme-Entwickler-Tutorial: 3. CSS in Themes
- 4 – Outlets: Theme-Entwickler-Tutorial: 4. Outlets zum Einfügen und Ersetzen von Inhalten verwenden
- 5 – Komponenten: Theme-Entwickler-Tutorial: 5. Erstellen und Verwenden von Komponenten
- 6 – JS-API: Theme-Entwickler-Tutorial: 6. Die JS-API verwenden
- 7 – Abschluss: Theme-Entwickler-Tutorial: 7. Zusammenfassung