Adicionando metadados e capturas de tela a um Theme

Você pode adicionar vários metadados a um tema. Alguns são armazenados no arquivo about.json e outros são armazenados nos arquivos de localidade.

about.json :link: informações sobre o formato do arquivo

name (string, obrigatório): O nome padrão para o tema quando instalado. Isso pode ser alterado pelos administradores após a instalação do tema.

component (boolean, padrão false): se o tema deve ser tratado como um componente.

license_url (string, opcional): uma URL para um arquivo de licença. Um link para isso será exibido na interface de administração. A maioria dos temas usa isso para vincular ao seu arquivo de licença no GitHub.

about_url (string, opcional): uma URL que contém mais informações sobre o tema. Um link para isso será exibido na interface de administração. A maioria dos temas usa isso para vincular ao seu tópico no Meta.

authors (string, opcional): Uma string para descrever o autor do tema. Exibido na interface de administração.

theme_version (string, opcional): Uma string arbitrária para descrever a versão do tema. Exibido na interface de administração.

screenshots (array, opcional): Até dois caminhos de captura de tela que serão usados em vários lugares da UI para exibir capturas de tela do tema. Veja abaixo para mais detalhes sobre restrições.

minimum_discourse_version (string, opcional): a versão mais antiga do discourse com a qual este tema é compatível. Se não corresponder, o tema será desativado automaticamente. Deve estar no formato 2.4.0.beta1.

maximum_discourse_version (string, opcional): a versão mais recente do discourse com a qual este tema é compatível. Se não corresponder, o tema será desativado automaticamente. Deve estar no formato 2.4.0.beta1.

Arquivos de localidade (ex: en.yml) :link: informações sobre o formato do arquivo

theme_metadata.description: Uma descrição localizada do tema. Exibida na interface de administração.

theme_metadata.settings.setting_name: Uma descrição localizada de setting_name, exibida abaixo da configuração do tema no painel de administração.

Capturas de tela

Temas e componentes podem definir um máximo de duas capturas de tela na chave screenshots do about.json, que ficará assim:

"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]

Tenha em mente estas restrições:

  • As capturas de tela devem estar em uma pasta screenshots no repositório GitHub do tema
  • Tamanho máximo do arquivo: 1 MB
  • Resolução máxima: 3840×2160 (4K)
  • Proporção recomendada: 16:9
  • Formatos permitidos: .webp, .png, .jpeg, .jpg

Nós também seguimos uma convenção de incluir capturas de tela light (clara) e dark (escura).


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

14 curtidas