Estrutura de temas e componentes de tema

O Discourse suporta temas nativos que podem ser obtidos a partir de um arquivo .tar.gz ou de um repositório git remoto, incluindo repositórios privados.

Um exemplo de tema está em: GitHub - discourse/discourse-simple-theme: Sam's simple discourse theme

O repositório git será verificado em busca de atualizações (uma vez por dia), ou usando o botão Verificar atualizações. Quando alterações forem detectadas, o botão Verificar atualizações mudará para Atualizar para a mais recente.

image

Para criar um tema, você precisa seguir uma estrutura de arquivos específica. Estes são os arquivos que você pode incluir:

about.json (obrigatório)

common/common.scss
common/header.html
common/after_header.html
common/footer.html
common/head_tag.html
common/body_tag.html
common/embedded.scss

desktop/desktop.scss
desktop/header.html
desktop/after_header.html
desktop/footer.html
desktop/head_tag.html
desktop/body_tag.html

mobile/mobile.scss
mobile/header.html
mobile/after_header.html
mobile/footer.html
mobile/head_tag.html
mobile/body_tag.html

locales/en.yml
locales/{locale}.yml

stylesheets/{anything}/{anything}/{anything}.scss

javascripts/{anything}.js
javascripts/{anything}.hbs
javascripts/{anything}.hbr

assets/{asset_filename}

settings.yml

Quaisquer um desses arquivos :arrow_up: são opcionais, então você só precisa criar os que necessita.

Para aqueles que procuram dividir o SCSS do tema em vários arquivos, isso agora é possível.

Para aqueles que procuram dividir o tema em vários arquivos JS, basta adicionar os arquivos JS desejados no diretório javascripts.

A estrutura do arquivo about.json está abaixo, e você pode ver mais informações sobre ele em https://meta.discourse.org/t/adding-metadata-to-a-theme/119205:

{
  "name": "My Theme",
  "component": false,
  "license_url": null,
  "about_url": null,
  "authors": null,
  "theme_version": null,
  "minimum_discourse_version": null,
  "maximum_discourse_version": null,
  "assets": {
    "variable-name": "assets/my-asset.jpg"
  },
  "color_schemes": {
    "My Color Scheme": {
      "primary": "222222"
    }
  },
  "screenshots": ["screenshots/light.jpeg", "screenshots/dark.jpeg"]
}

Instruções sobre como adicionar configurações ao seu tema disponíveis aqui: Add settings to your Discourse theme.

Para informar ao Discourse que você adicionará um componente de tema e não um tema completo, basta adicionar a linha "component": true ao arquivo about.json

A estrutura de arquivos corresponde ao CSS/HTML personalizado do tema.

Leitura adicional

Confira os outros artigos com a tag #themes::tag.

:information_source: Veja também:


Última Revisão por @SaraDev em 2022-08-15T21:00:00Z


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

62 curtidas
Alien Night Theme - A free Dark Theme for Discourse
Override values for auto-generated color variables
How to modify the header HTML, but still remaining the default founctions
Custom user fields show on Activity, but not Summary page
Add Unsolved button to top menu using custom HTML
How do I get started with Discourse development as a regular end user with no programming experience?
Custom assets upload folder?
Some basic questions about discourse and rails
Color Scheme Contest (with Prizes!)
Add support for theme settings
Create and share a font theme component
Create and share a color scheme
Split up theme SCSS into multiple files
Theme Developer Quick Reference Guide
Theme Developer Tutorial: 2. Creating a remote theme
Mobile View Loading different HTML as compared to Desktop
Developing Discourse Themes & Theme Components
Minimizing Maintenance on Theme Customizations
Need help with theme component Github
Allow users to select new color palettes
Challenges creating a custom color palette
Adding metadata and screenshots to a Theme
Push to digital ocean from command line and rebuild
Battle Axe - A free theme by the Tappara.co hockey community
Beginner's guide to using Discourse Themes
Discourse deployment using github or bitbucket?
How to remove sticky top bar?
Do you have original customisations?
Add custom content that only appears on your homepage
Highlight color
Timefuser Theme
Compact member list
Understanding the development/deployment process
CSS Theme Contest (with Prizes!)
How to bring in Latest topics when using category boxes
Need to include PGN (chess game notation) in a post
Custom header colour and category icons and login button
Automatic dark mode for embedded comments as well?
Add settings to your Discourse theme
Designer's Guide to getting started with themes in Discourse