Discourse Theme CLI-App installieren, um Themes zu erstellen

[Discourse]

Die Discourse Theme CLI ist ein Ruby-Gem, das es dir ermöglicht, bei der Entwicklung von Discourse-Themes und Theme-Komponenten deinen bevorzugten Editor zu verwenden. Wenn du Dateien speicherst, aktualisiert die CLI das Remote-Theme oder die Komponente, und die Änderungen werden live angezeigt!

Installation

Um es auszuprobieren, stelle sicher, dass Ruby 2.5 oder höher installiert ist.

Wenn du Windows verwendest, hast du 2 Optionen:

Option 1: Windows Subsystem for Linux.

Windows 10 bietet Zugriff auf eine vollständige Linux-Umgebung. Du kannst sie nutzen, um Ruby einfach mit sudo apt-get install ruby zu installieren; dabei wird Ruby 2.3 installiert.

Option 2: Ältere Windows-Versionen

Ältere Windows-Versionen haben keinen Zugriff auf WSL. Du kannst Ruby problemlos mit dem Ruby Installer installieren. Wähle die empfohlene Version und die Standardeinstellungen für die Installation.

Mac OS Version 10.13.3 wird mit Ruby 2.3 ausgeliefert, es ist nichts Besonderes erforderlich. Wenn du eine frühere Version von Mac OS verwendest, erwäge die Verwendung von rvm, rbenv oder homebrew, um eine aktuelle Ruby-Version zu installieren.

---

Sobald Ruby 2.2 oder höher ausgeführt wird, öffne ein Terminal oder eine Befehlsschale und führe Folgendes aus:

gem install discourse_theme

Nach der Installation kannst du Folgendes ausführen, um mehr darüber zu erfahren:

discourse_theme

Aktualisierung

gem update discourse_theme

Funktionen

Die CLI bietet 3 Hauptfunktionen:

discourse_theme new

Du kannst sie verwenden, um schnell ein neues Theme mit discourse_theme new YOUR_DIR_NAME zu erstellen.

discourse_theme watch

Du kannst sie verwenden, um ein Theme zu überwachen und mit einer Discourse-Website synchron zu halten (mit Live-Refresh) unter Verwendung von discourse_theme watch YOUR_DIR_NAME.

Das bedeutet, dass du deinen eigenen Editor verwenden kannst, um dein Theme zu bearbeiten, und die Website wird magisch mit den Änderungen aktualisiert!

discourse_theme download

Du kannst ein bestehendes Theme von Discourse mit discourse_theme download YOUR_DIR_NAME herunterladen. Danach hast du die Möglichkeit, sofort mit dem “Watchen” zu beginnen!

Zugangsdaten

Du musst einen API-Key generieren. Gehe zum Admin-Bereich und generiere dort einen Key.

• Wähle beim Generieren des Keys eine „User Level“ von Single User, nicht All Users.
• Stelle sicher, dass du Global Key anhäkst, sonst erhältst du 403 Forbidden-Fehler.

Zugangsdaten werden (optional) unter ~/.discourse_theme gespeichert. API-Keys werden pro Website gespeichert, und die URL/theme_id für jedes Verzeichnis wird ebenfalls erfasst. Falls du deine Einstellungen jemals ändern musst, füge einfach --reset zu einem beliebigen Befehl hinzu, und du wirst erneut nach allen Werten gefragt.

Empfehlungen

„Dieses Tool ist wahrhaftig ein GEM!“ @awole20
„Das ist sehr, sehr gut.“ @awesomerobot
„Es funktioniert Und es ist ziemlich dosh garn cool. Toll!“ @angus
„OMG. Es ist unglaublich.“ @pfaffman

---

Dieses Dokument wird versioniert verwaltet – schlage Änderungen auf github vor.

[riladant]

Uploads über Admin \u003e\u003e Anpassen \u003e\u003e Designs verschwinden, nachdem ein beobachtetes Design gespeichert wurde.

Wie können wir Bild-Assets in das Design aufnehmen, damit sie nach dem Speichern nicht verloren gehen?

[Arkshine]

Hallo, willkommen!

Sie müssen die Assets direkt in Ihre Theme-Komponente aufnehmen.
Im Stammverzeichnis erstellen Sie ein Verzeichnis assets.
Deklarieren Sie sie dann in about.json

"assets": {
  "<your_identifier>": "assets/<your_asset_filename>",
}

Ein Beispiel finden Sie hier: GitHub - MeghnaAJ/discourse-christmas-decorations.

[Arkshine]

Eine kurze Information für Entwickler, die dieses Tool zur Generierung von Theme-Komponenten verwenden:
Sie werden ermutigt, es zu aktualisieren!

Ein kürzlich erstellter PR hat das discourse-theme-skeleton Repository als Standardvorlage festgelegt. Es wird Ihnen die neuesten Konfigurationsdateien liefern!

[carbonrich (Richard Hawkins)]

Danke!

Es wäre großartig, einen Abschnitt „Update“ zum Thema hinzuzufügen…

Ist es ein --reset oder ein Rubygem-Update?

[david (David Taylor)]

Gute Idee! Ich habe einen „Upgrading“-Abschnitt zum OP hinzugefügt

gem update discourse_theme

[Heinenen]

Um das Gem auf WSL zu installieren, musste ich sowohl sudo apt-get install ruby als auch sudo apt-get install ruby-dev ausführen.
Vielleicht kann das zu den Installationsanweisungen hinzugefügt werden.

[tgxworld (Alan Tan)]

@sam

Windows 10 hat Zugriff auf eine vollständige Linux-Umgebung, Sie können damit Ruby einfach mit sudo apt-get install ruby installieren, dies gibt Ihnen Ruby 2.3.

Wenn Sie ruby-dev nicht installieren, erhalten Sie dann einen Fehler? Es sollte nicht notwendig sein, ruby-dev zu installieren, da ruby selbst ausreichend ist.

[Heinenen]

Ich bin ziemlich sicher, dass ich eine Fehlermeldung erhalten habe, in der mir geraten wurde, ruby-dev zu installieren, sonst hätte ich nicht gewusst, dass das Paket existiert.
Aber ich kann es durch erneute Installation nicht reproduzieren. Vielleicht habe ich es beim ersten Mal seltsam gemacht.

[tgxworld (Alan Tan)]

Das ist in der Tat seltsam. Lassen Sie mich wissen, wenn Sie das Problem erneut reproduzieren können.

[manuel (Manuel Kostka)]

Ich habe meinen Server gestern auf 3.5.0.beta9-dev aktualisiert und erhalte seitdem keine Live-Reloads mehr mit dem Discourse-Theme-Gem. Das Gem ist Version 2.1.6.

Ich sehe keine Fehler oder ähnliches, daher wollte ich zuerst fragen, ob noch jemand das gleiche Problem hat?

[david (David Taylor)]

Live-Reloads von Stylesheets wurden für Produktionsinstanzen deaktiviert, da sie Probleme beim Aktualisieren von Themes und/oder Discourse-Core verursachten.

Grundsätzlich gilt: Änderungen an Stylesheets sind oft mit Änderungen an JS/HTML verbunden, daher ist ein Live-Laden nur für Stylesheets riskant. Benutzer führen dann ‘neue’ Stylesheets gegen ‘alten’ HTML-Code aus, was zu sehr seltsamen Erfahrungen führen kann.

Live-Laden ist für Discourse-Instanzen im Entwicklungsmodus weiterhin aktiviert. Idealerweise sollten Sie diesen für die Entwicklung verwenden und nicht eine Produktionsseite. Abgesehen vom Stylesheet-Reload bietet der Ember-Entwicklungsmodus weitaus hilfreichere Fehlermeldungen als der Ember-Produktionsmodus.

[pfaffman (Jay Pfaffman)]

@david

Live-Neuladen von Stylesheets wurde für Produktionsinstanzen deaktiviert, da sie Probleme beim Aktualisieren von Themes und/oder Discourse-Core verursachten.

Das ist eine große Änderung. Ich bin überrascht, dass es keine Ankündigung gab. Ich habe die Theme-Entwicklung hauptsächlich nur auf Produktionsseiten durchgeführt.

Eine Site-Einstellung, um das alte Verhalten zu erhalten, wäre nett.

[rahim123]

Zustimmung, das hat mich überrascht, und ich konnte diesen aktuellen Thread trotz Suche nicht finden, oder vielleicht habe ich das ältere OP-Datum gesehen und es ignoriert.

No more live reload with CSS modifications?

Hi there, I just upgraded to 3.5.0. In previous versions it would immediately apply CSS modifications in theme components without reloading the page. This doesn’t seem to be working anymore. Is it broken, or is it disabled? Thanks a lot!

[sk-or-v1-contents]

Kann jemand einen Screenshot des Bereichs „Apps“ in den Einstellungen machen? Ich finde ihn nicht.

Um den Zugriff für diesen Schlüssel zu widerrufen, besuchen Sie den Bereich „Apps“ in Ihren Benutzereinstellungen.

[merefield (Robert)]

Es befindet sich unter „Sicherheit“ unten (in den Einstellungen)

Dieser Text könnte verbessert werden, z. B.:

Um den Zugriff für diesen Schlüssel zu widerrufen, gehen Sie im Abschnitt „Apps“ Ihrer Benutzereinstellungen zu „Sicherheit“.

[sk-or-v1-contents]

Ich sehe es jetzt. Vielleicht muss man die Seite neu laden, damit es angezeigt wird.