Dokumentation zur Erweiterung von Discourse mit Plugins, Themes und Theme-Komponenten, zur Arbeit mit dem Kerncode und zur Nutzung der Discourse-API.
Einführung
- Einführung: Einführung in die Discourse-Entwicklung
Entwicklungsumgebungen
- Dev Container: Discourse mit einem Dev Container entwickeln
- GitHub Codespaces: Discourse in GitHub Codespaces entwickeln
- 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
- Nicht-Docker-Plugins: Plugins in deiner nicht-Docker-Entwicklungsumgebung installieren
- Lokales Setup: Eine lokale Discourse-Entwicklungsumgebung einrichten?
- Multisite-Setup: Eine Multisite-Entwicklungsumgebung einrichten
- Fedora-Setup: Discourse für die Entwicklung auf Fedora Linux einrichten
Code & Interna
- Ember-Komponenten: Ember-Komponenten zu Discourse hinzufügen
- UI-Kit: Das UI-Kit mit gemeinsamen Discourse-Komponenten, Helfern und Modifiern
- Lint und Formatierung: Code automatisch vor Commits linten und formatieren
- Akzeptanztests: Akzeptanztests und Komponententests für Ember-Code in Discourse schreiben
- Test-Suiten ausführen: So führen Sie die QUnit-Test-Suiten für Discourse-Kern, Plugins und Themes aus
- Versionskompatibilität: Versions-Pinning für Plugins und Themes für ältere Discourse-Installationen (d-compat-Zweige)
- Ember-Objekteigentum: Ember-Objekteigentum (getOwner, Service-Injektionen usw.)
- JS-Performance: Verwendung von Googles ‘tachometer’ zur Messung von JS-Performance-Änderungen in Discourse
- CI mit GitHub Actions: Einführung von Continuous Integration mit GitHub Actions
- Markdown-Erweiterungen: Entwicklerhandbuch zu 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 (auch Popups/Dialoge genannt) 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 Kernverhaltens
- Routen erstellen: Routen in Discourse erstellen und Daten anzeigen
- Authentifizierungsmethode: Hinzufügen einer neuen ‘verwalteten’ Authentifizierungsmethode zu Discourse
- Unbeabsichtigte Serialisierung von ActiveRecord-Modellen: Verhinderung der unbeabsichtigten Serialisierung von ActiveRecord-Modellen
- Templates überschreiben: (nicht empfohlen) Überschreiben von Discourse-Templates aus einem Theme oder Plugin
- 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-Trigger: AppEvents-Trigger-Referenz
- Transformer: Verwendung von Transformern zur Anpassung von Client-Werten und -Verhalten
- 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)
- Gesten-Primitiven: Drag, Resize und Gesten-Primitiven
- Bundle-Splitting: Bundle-Splitting für Plugins
Plugins
- Basis-Plugin: Entwicklung von Discourse-Plugins - Teil 1 - Ein Basis-Plugin erstellen
- Plugin-Outlet: Entwicklung von Discourse-Plugins - Teil 2 - Mit einem Plugin-Outlet verbinden
- Seiteneinstellungen: Entwicklung von Discourse-Plugins - Teil 3 - Eigene Seiteneinstellungen 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 - Ihr Plugin veröffentlichen
- Neue Locales: Eine neue Locale aus einem Plugin hinzufügen
- Chat-Integration: Einen neuen Anbieter zu discourse-chat-integration hinzufügen
- markdown-it-Erweiterung: Neuverpackung einer markdown-it-Erweiterung als Discourse-Plugin
- Rails-Autoloading: Strukturierung eines Plugins für Rails-Autoloading
Themes & Komponenten
- Themes entwickeln: Entwicklung von Discourse-Themes & Theme-Komponenten
- Schnellreferenz: Schnellreferenz für Theme-Entwickler
- Handbuch für Designer: Handbuch für Designer zum Einstieg in Themes in Discourse
- Theme Creator: Einsteigen mit Theme Creator und der Theme-CLI
- Theme-CLI: Die Discourse-Theme-CLI-Konsolen-App installieren, um 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 Ihrem Discourse-Theme hinzufügen
- Objekte für Theme-Einstellungen: Objekttyp für Theme-Einstellung
- Einstellungen migrieren: Discourse-Theme-Einstellungen migrieren
- Theme-Metadaten: Metadaten und Screenshots zu einem Theme hinzufügen
- Kernvariablen: Discourse-Kernvariablen in Ihrem Theme verwenden
- Lokalisierbare Zeichenfolgen: Lokalisierbare Zeichenfolgen 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
- Eigene Icons: Standard-SVG-Icons von Discourse in einem Theme durch eigene Icons ersetzen
- Dunkler Modus: Themes und Plugins aktualisieren, um den automatischen dunklen Modus zu unterstützen
- Theme-Modifier: Theme-Modifier: Eine kurze Einführung
- Pseudoelemente: Text oder Bilder überall auf Ihrer 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
- Startseiteninhalt: Eigene Inhalte hinzufügen, die nur auf Ihrer Startseite angezeigt werden
- Nachrichtenformat: Message-Format-Unterstützung für Lokalisierung
- Globale Icon-Änderungen: Icons global ändern
- Alternative Icons: Alternative Icons
- Wiki-Beitragsstil: Den Stil eines Wiki-Beitrags ändern
- Farbschema: Ein Farbschema erstellen und teilen
- Navigationsmenü: Den Abfrageparameter
navigation_menuverwenden, um die Seitenleiste oder andere Optionen zu previewen - Beitragsinhalts-Stile: Inhalte von Beiträgen mit eigenen Stilen anpassen
- Theme-Screenshots: Vorschau-Screenshots zu Discourse-Themes hinzufügen
- Thematisierbare Seiteneinstellungen: Seiteneinstellungen mit Themes steuern
Allgemeine Anleitungen
- White-Labeling von Mobile-Apps: Überlegungen vor der Entscheidung, die Discourse-Mobile-Apps zu white-labeln
- Eigene Automatisierungen: Eigene Automatisierungen erstellen
- Öffentliche Datenablage: Discourse Öffentliche Datenablage
- KI-Evals: Discourse-KI-Evals ausführen
- KI-Bot über API: Verwendung des KI-Bots über die Discourse-API
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 - Schlussfolgerung: Theme-Entwickler-Tutorial: 7. Zusammenfassung