Installa l'app console Discourse Theme CLI per aiutarti a creare temi

[Discourse]

Il Discourse Theme CLI è una gemma ruby che ti permette di usare l’editor che preferisci quando sviluppi temi o componenti tema di Discourse. Quando salvi i file, la CLI aggiornerà il tema o componente remoto e le modifiche appariranno in tempo reale!

Installazione

Per provarlo, assicurati di avere installato Ruby 2.5 o superiore.

Se usi Windows, hai 2 opzioni:

Opzione 1: Windows Subsystem for Linux.

Windows 10 ha accesso a un ambiente Linux completo, puoi usarlo per installare ruby semplicemente con sudo apt-get install ruby, questo ti darà Ruby 2.3.

Opzione 2: Windows più vecchio

Le versioni più vecchie di Windows non hanno accesso a WSL, puoi installare facilmente Ruby con Ruby Installer, scegli la versione consigliata e le impostazioni predefinite per l’installazione.

Mac OS versione 10.13.3 viene fornito con Ruby 2.3 di serie, non è necessario nulla di speciale. Se stai usando una versione precedente di Mac OS considera l’uso di rvm, rbenv o homebrew per installare una versione recente di ruby.

---

Una volta che Ruby 2.2 o successivo è in esecuzione, apri un terminale o un prompt dei comandi ed esegui:

gem install discourse_theme

Una volta installato, per saperne di più:

discourse_theme

Aggiornamento

gem update discourse_theme

Funzionalità

La CLI fornisce 3 funzioni principali:

discourse_theme new

Puoi usarla per creare rapidamente un nuovo tema con discourse_theme new NOME_TUA_DIRECTORY

discourse_theme watch

Puoi usarla per monitorare un tema e sincronizzarlo con un sito discourse (con aggiornamento in tempo reale) usando discourse_theme watch NOME_TUA_DIRECTORY

Ciò significa che puoi usare il tuo editor per modificare il tuo tema e il sito si aggiornerà magicamente con le modifiche!

discourse_theme download

Puoi scaricare un tema esistente da Discourse usando discourse_theme download NOME_TUA_DIRECTORY. Ti verrà quindi data l’opzione di iniziare a “monitorare” subito!

Credenziali

Dovrai generare una Chiave API. Vai all’area admin e genera una chiave lì.

• Seleziona un “Livello Utente” di Utente Singolo quando generi la chiave, non Tutti gli Utenti.
• Assicurati di spuntare Chiave Globale o riceverai errori 403 forbidden.

Le credenziali sono (facoltativamente) memorizzate in ~/.discourse_theme. Le chiavi API sono memorizzate per sito, e anche l’URL/theme_id per ogni directory viene tracciato. Se hai mai bisogno di cambiare le tue impostazioni, aggiungi semplicemente --reset a qualsiasi comando e ti verranno richieste nuovamente tutte le impostazioni.

Testimonianze

“Questo strumento è veramente una GEMMA!” @awole20
“Questo è molto molto buono.” @awesomerobot
“Funziona Ed è piuttosto dannatamente bello. Ottimo!” @angus
“OMG. È incredibile.” @pfaffman

---

Questo documento è controllato in versione - suggerisci modifiche su github.

[riladant]

Uploads tramite Admin >> Personalizza >> Temi scompaiono dopo il salvataggio di un tema osservato.

Come includiamo gli asset di immagine nel tema in modo che non vengano eliminati dopo il salvataggio?

[Arkshine]

Ciao, benvenuto!

Devi includere gli asset direttamente nel tuo componente del tema.
Alla radice, crei una directory assets.
Quindi, li dichiari in about.json

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

Puoi vedere un esempio qui GitHub - MeghnaAJ/discourse-christmas-decorations.

[Arkshine]

Un breve avviso per gli sviluppatori che utilizzano questo strumento per generare componenti del tema:
Si incoraggia l’aggiornamento!

Una recente PR ha reso il repository discourse-theme-skeleton il modello predefinito. Ti fornirà i file di configurazione più recenti!

[carbonrich (Richard Hawkins)]

Grazie!

Sarebbe fantastico aggiungere una sezione Aggiornamento all’argomento…

È un aggiornamento --reset o un aggiornamento rubygem?

[david (David Taylor)]

Ottima idea! Ho aggiunto una sezione ‘aggiornamento’ all’OP

gem update discourse_theme

[Heinenen]

Per installare la gemma su WSL, ho dovuto eseguire sia sudo apt-get install ruby che sudo apt-get install ruby-dev.
Forse questo può essere aggiunto alle istruzioni di installazione.

[tgxworld (Alan Tan)]

@sam

Windows 10 ha accesso a un ambiente Linux completo, puoi usarlo per installare ruby semplicemente con sudo apt-get install ruby, questo ti darà Ruby 2.3.

Se non installi ruby-dev, ottieni un errore? Non dovrebbe essere necessario installare ruby-dev poiché ruby da solo è sufficiente.

[Heinenen]

Sono abbastanza sicuro di aver ricevuto un errore che mi diceva di installare ruby-dev, altrimenti non avrei saputo che il pacchetto esistesse.
Ma non riesco a riprodurlo provando a reinstallarlo. Forse ho fatto qualcosa di strano la prima volta.

[tgxworld (Alan Tan)]

Hmm, è davvero strano. Sentiti libero di farmelo sapere se riesci a riprodurre di nuovo il problema.

[manuel (Manuel Kostka)]

Ho aggiornato il mio server ieri a 3.5.0.beta9-dev e non ottengo più i live reload con il discourse theme gem. La gem è alla versione 2.1.6.

Non vedo errori o altro, quindi volevo prima chiedere se qualcun altro ha lo stesso problema?

[david (David Taylor)]

I ricaricamenti in tempo reale degli stylesheet sono stati disabilitati per le istanze di produzione, poiché causavano problemi durante l’aggiornamento di temi e/o del core di Discourse.

Fondamentalmente: le modifiche agli stylesheet sono spesso legate a modifiche in JS/HTML, quindi il caricamento in tempo reale solo per gli stylesheet è rischioso. Gli utenti finiscono per eseguire “nuovi” stylesheet contro HTML “vecchio”, il che può portare a esperienze molto strane.

Il caricamento in tempo reale è ancora abilitato per le istanze di Discourse in modalità di sviluppo. Idealmente, dovresti usarlo per lo sviluppo piuttosto che per un sito di produzione. Oltre al ricaricamento degli stylesheet, la modalità di sviluppo di Ember ti offre messaggi di errore molto più amichevoli rispetto alla modalità di produzione di Ember.

[pfaffman (Jay Pfaffman)]

@david

I ricaricamenti live dei fogli di stile sono stati disabilitati per le istanze di produzione, perché stavano causando problemi durante l’aggiornamento di temi e/o del core di Discourse.

È un grande cambiamento. Sono sorpreso che non ci sia stato un annuncio. Avevo sviluppato temi principalmente solo su siti di produzione.

Una impostazione del sito per ottenere il vecchio comportamento potrebbe essere utile.

[rahim123]

Concordo, questo mi ha sorpreso e non sono riuscito a trovare questo thread attuale nonostante la ricerca, o forse ho visto la data della OP precedente e l’ho ignorata.

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!