Instala la aplicación de consola Discourse Theme CLI para ayudarte a construir temas

[Discourse]

El Discourse Theme CLI es una gema de ruby que te permite usar el editor de tu elección cuando desarrollas temas y componentes de temas de Discourse. Al guardar archivos, la CLI actualizará el tema o componente remoto y los cambios aparecerán en vivo.

Instalación

Para probarlo, asegúrate de tener instalado Ruby 2.5 o superior.

Si estás en Windows, tienes 2 opciones:

Opción 1: Subsistema de Windows para Linux.

Windows 10 tiene acceso a un entorno Linux completo, puedes usarlo para instalar ruby simplemente con sudo apt-get install ruby, esto te dará Ruby 2.3.

Opción 2: Windows más antiguo

Las versiones anteriores de Windows no tienen acceso a WSL, puedes instalar Ruby fácilmente con Ruby Installer, elige la versión recomendada y la configuración predeterminada para la instalación.

Mac OS versión 10.13.3 viene con Ruby 2.3 de fábrica, no se necesita nada especial. Si estás usando una versión anterior de Mac OS, considera usar rvm, rbenv o homebrew para instalar un ruby reciente.

---

Una vez que Ruby 2.2 o posterior se esté ejecutando, abre una terminal o un shell de comandos y ejecuta:

gem install discourse_theme

Una vez instalado, para aprender más sobre él:

discourse_theme

Actualización

gem update discourse_theme

Características

La CLI proporciona 3 funciones principales:

discourse_theme new

Puedes usarlo para crear rápidamente un nuevo tema con discourse_theme new NOMBRE_DE_TU_DIRECTORIO

discourse_theme watch

Puedes usarlo para monitorear un tema y sincronizarlo con un sitio de discourse (con actualización en vivo) usando discourse_theme watch NOMBRE_DE_TU_DIRECTORIO

¡Esto significa que puedes usar tu propio editor para editar tu tema y el sitio se actualizará mágicamente con los cambios!

discourse_theme download

Puedes descargar un tema existente de Discourse usando discourse_theme download NOMBRE_DE_TU_DIRECTORIO. ¡Luego se te dará la opción de comenzar a “monitorear” de inmediato!

Credenciales

Necesitarás generar una Clave de API. Ve al área de administración y genera una clave allí.

• Selecciona un nivel de “Usuario” de Usuario Único al generar la clave, no Todos los Usuarios.
• Asegúrate de marcar Clave Global o recibirás errores 403 forbidden.

Las credenciales se almacenan (opcionalmente) en ~/.discourse_theme. Las claves de API se almacenan por sitio, y también se realiza un seguimiento de la URL/theme_id para cada directorio. Si alguna vez necesitas cambiar tu configuración, simplemente agrega --reset a cualquier comando y se te pedirá todos los valores nuevamente.

Testimonios

“¡Esta herramienta es verdaderamente una GEMA!” @awole20
“Esto es muy, muy bueno.” @awesomerobot
“Está funcionando Y es bastante genial. ¡Genial!” @angus
“Dios mío. Es increíble.” @pfaffman

---

Este documento está controlado por versión: sugiere cambios en github.

[riladant]

Las Cargas en Admin >> Personalizar >> Temas desaparecen después de guardar un tema observado.

¿Cómo incluimos los activos de imagen en el tema para que no se eliminen después de guardar?

[Arkshine]

Hola, ¡bienvenido!

Necesitas incluir los activos directamente en tu componente de tema.
En la raíz, creas un directorio assets.
Luego, los declaras en about.json

"assets": {
  "<tu_identificador>": "assets/<tu_nombre_archivo_activo>",
}

Puedes ver un ejemplo aquí GitHub - MeghnaAJ/discourse-christmas-decorations.

[Arkshine]

Una advertencia rápida para los desarrolladores que usan esta herramienta para generar componentes de temas:
¡Se les anima a actualizarla!

Una PR reciente hizo que el repositorio discourse-theme-skeleton sea la plantilla predeterminada. ¡Les proporcionará los últimos archivos de configuración!

[carbonrich (Richard Hawkins)]

¡Gracias!

Sería genial añadir una sección de Actualización al tema…

¿Es una actualización de --reset o de rubygem?

[david (David Taylor)]

¡Buena idea! He añadido una sección de ‘actualización’ al OP

gem update discourse_theme

[Heinenen]

Para instalar el gem en WSL, tuve que ejecutar tanto sudo apt-get install ruby como sudo apt-get install ruby-dev.
Quizás eso se pueda añadir a las instrucciones de instalación.

[tgxworld (Alan Tan)]

@sam

Windows 10 tiene acceso a un entorno Linux completo, puedes usarlo para instalar ruby simplemente con sudo apt-get install ruby, esto te dará Ruby 2.3.

Si no instalas ruby-dev, ¿recibes un error? No debería ser necesario instalar ruby-dev ya que ruby en sí mismo es suficiente.

[Heinenen]

Estoy bastante seguro de que recibí un error que me indicaba que instalara ruby-dev, de lo contrario no habría sabido que el paquete existía.
Pero no puedo reproducirlo intentando reinstalar. Quizás hice algo raro la primera vez.

[tgxworld (Alan Tan)]

Hmm, eso es realmente extraño. No dudes en avisarme si puedes reproducir el problema de nuevo.

[manuel (Manuel Kostka)]

Actualicé mi servidor ayer a 3.5.0.beta9-dev y no obtengo recargas en vivo con el gem del tema de discourse desde entonces. El gem es la versión 2.1.6.

No veo ningún error ni nada, así que primero quería preguntar si alguien más tiene el mismo problema.

[david (David Taylor)]

Las recargas en vivo de las hojas de estilo se han deshabilitado para instancias de producción, ya que estaban causando problemas al actualizar temas y/o el núcleo de Discourse.

Fundamentalmente: los cambios en las hojas de estilo a menudo están ligados a cambios en JS/HTML, por lo que la carga en vivo solo para las hojas de estilo es arriesgada. Los usuarios terminan ejecutando hojas de estilo ‘nuevas’ contra HTML ‘antiguo’, lo que puede llevar a experiencias muy extrañas.

La carga en vivo todavía está habilitada para instancias de Discourse en modo de desarrollo. Idealmente, deberías usar eso para el desarrollo en lugar de un sitio de producción. Aparte de la recarga de la hoja de estilo, el modo de desarrollo de Ember te da mensajes de error mucho más amigables que el modo de producción de Ember.

[pfaffman (Jay Pfaffman)]

@david

Las recargas en vivo de las hojas de estilo se han deshabilitado para instancias de producción, porque estaban causando problemas al actualizar temas y/o el núcleo de Discourse.

Ese es un gran cambio. Me sorprende que no hubiera un anuncio. Había estado desarrollando temas principalmente solo en sitios de producción.

Sería bueno tener una configuración del sitio para obtener el comportamiento anterior.

[rahim123]

De acuerdo, esto me sorprendió y no pude encontrar este hilo actual a pesar de buscar, o tal vez vi la fecha anterior del OP y la ignoré.

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!