Instale o aplicativo de console Discourse Theme CLI para ajudar você a construir temas

[Discourse]

O Discourse Theme CLI é um gem ruby que permite que você use seu editor de preferência ao desenvolver temas e componentes de tema do Discourse. Ao salvar arquivos, o CLI atualizará o tema ou componente remoto e as alterações aparecerão ao vivo!

Instalação

Para brincar com ele, certifique-se de ter o Ruby 2.5 ou superior instalado.

Se você estiver no Windows, você tem 2 opções:

Opção 1: Windows Subsystem for Linux.

O Windows 10 tem acesso a um ambiente Linux completo, você pode usá-lo para instalar o ruby simplesmente com sudo apt-get install ruby, isso lhe dará o Ruby 2.3.

Opção 2: Windows mais antigo

Versões mais antigas do Windows não têm acesso ao WSL, você pode facilmente instalar o Ruby com o Ruby Installer, escolha a versão recomendada e as configurações padrão para a instalação.

A versão 10.13.3 do Mac OS vem com o Ruby 2.3 de fábrica, nada de especial é necessário. Se você estiver usando uma versão anterior do Mac OS, considere usar rvm, rbenv ou homebrew para instalar um ruby recente.

---

Assim que o Ruby 2.2 ou posterior estiver em execução, abra um terminal ou shell de comando e execute:

gem install discourse_theme

Após a instalação, para saber mais sobre ele:

discourse_theme

Atualização

gem update discourse_theme

Funcionalidades

O CLI fornece 3 funções principais:

discourse_theme new

Você pode usá-lo para criar rapidamente um novo tema com discourse_theme new NOME_DO_SEU_DIRETORIO

discourse_theme watch

Você pode usá-lo para monitorar um tema e sincronizar com um site do discourse (com atualização ao vivo) usando discourse_theme watch NOME_DO_SEU_DIRETORIO

Isso significa que você pode usar seu próprio editor para editar seu tema e o site magicamente será atualizado com as alterações!

discourse_theme download

Você pode baixar um tema existente do Discourse usando discourse_theme download NOME_DO_SEU_DIRETORIO. Você terá então a opção de começar a “monitorar” imediatamente!

Credenciais

Você precisará gerar uma Chave de API. Vá para a área de administração e gere uma chave lá.

• Selecione um “Nível de Usuário” de Usuário Único ao gerar a chave, não Todos os Usuários.
• Certifique-se de marcar Chave Global ou você receberá erros 403 forbidden.

As credenciais são (opcionalmente) armazenadas em ~/.discourse_theme. As chaves de API são armazenadas por site, e a URL/theme_id para cada diretório também é rastreada. Se você precisar alterar suas configurações, basta adicionar --reset a qualquer comando e você será solicitado por todos os valores novamente.

Depoimentos

“Esta ferramenta é verdadeiramente uma GEM!” @awole20
“Isso é muito, muito bom.” @awesomerobot
“Está funcionando E é bem legal. Legal!” @angus
“OMG. É inacreditável.” @pfaffman

---

Este documento é controlado por versão - sugira alterações no github.

[riladant]

Uploads via Admin >> Personalizar >> Temas desaparecem após a gravação de um tema observado.

Como incluímos ativos de imagem no tema para que eles não sejam eliminados após a gravação?

[Arkshine]

Olá, bem-vindo!

Você precisa incluir os assets diretamente no seu componente de tema.
Na raiz, você cria um diretório assets.
Em seguida, você os declara em about.json

"assets": {
  "<seu_identificador>": "assets/<seu_nome_de_arquivo_de_asset>",
}

Você pode ver um exemplo aqui GitHub - MeghnaAJ/discourse-christmas-decorations.

[Arkshine]

Um aviso rápido para desenvolvedores que usam esta ferramenta para gerar componentes de tema:
Você é encorajado a atualizá-la!

Um PR recente tornou o repositório discourse-theme-skeleton o modelo padrão. Ele fornecerá os arquivos de configuração mais recentes!

[carbonrich (Richard Hawkins)]

Obrigado!

Seria ótimo adicionar uma seção de Atualização ao tópico…

É um --reset ou uma atualização do rubygem?

[david (David Taylor)]

Boa ideia! Adicionei uma seção de ‘atualização’ ao OP

gem update discourse_theme

[Heinenen]

Para instalar a gem no WSL, tive que executar ambos os comandos:
sudo apt-get install ruby e sudo apt-get install ruby-dev.
Talvez isso possa ser adicionado às instruções de instalação.

[tgxworld (Alan Tan)]

@sam

O Windows 10 tem acesso a um ambiente Linux completo, você pode usá-lo para instalar o ruby simplesmente com sudo apt-get install ruby, isso lhe dará o Ruby 2.3.

Se você não instalar ruby-dev, você recebe um erro? Não deve ser necessário instalar ruby-dev, pois o ruby em si é suficiente.

[Heinenen]

Tenho quase certeza de que recebi um erro que me instruiu a instalar ruby-dev, caso contrário, eu não saberia que o pacote existia.
Mas não consigo reproduzi-lo ao tentar reinstalar. Talvez eu tenha feito algo estranho da primeira vez.

[tgxworld (Alan Tan)]

Hmm, isso é realmente estranho. Sinta-se à vontade para me informar se conseguir reproduzir o problema novamente.

[manuel (Manuel Kostka)]

Atualizei meu servidor ontem para 3.5.0.beta9-dev e não consigo mais recarregar em tempo real com o gem do tema discourse desde então. O gem é a versão 2.1.6.

Não vejo nenhum erro ou nada do tipo, então queria perguntar primeiro se mais alguém tem o mesmo problema?

[david (David Taylor)]

Recarregamentos em tempo real de folhas de estilo foram desativados para instâncias de produção, pois estavam causando problemas ao atualizar temas e/ou o core do Discourse.

Fundamentalmente: alterações de folhas de estilo frequentemente estão ligadas a alterações em JS/HTML, então o carregamento em tempo real apenas para folhas de estilo é arriscado. Usuários acabam executando folhas de estilo ‘novas’ contra HTML ‘antigo’, o que pode levar a experiências muito estranhas.

O carregamento em tempo real ainda está habilitado para instâncias do Discourse em modo de desenvolvimento. Idealmente, você usaria isso para desenvolvimento em vez de um site de produção. Além do recarregamento da folha de estilo, o Ember em modo de desenvolvimento oferece mensagens de erro muito mais amigáveis do que o Ember em modo de produção.

[pfaffman (Jay Pfaffman)]

@david

Recarregamentos ao vivo de folhas de estilo foram desativados para instâncias de produção, pois estavam causando problemas ao atualizar temas e/ou o núcleo do Discourse.

Essa é uma grande mudança. Fico surpreso que não tenha havido um anúncio. Eu estava desenvolvendo temas principalmente em sites de produção.

Uma configuração de site para obter o comportamento antigo seria legal.

[rahim123]

Concordo, isso me surpreendeu e não consegui encontrar este tópico atual, apesar de ter pesquisado, ou talvez eu tenha visto a data mais antiga do OP e o ignorado.

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!