Ajouter des métadonnées et des captures d'écran à un Theme

Vous pouvez ajouter diverses métadonnées à un thème. Certaines sont stockées dans le fichier about.json, et d’autres dans les fichiers de localisation.

about.json :link: informations sur le format de fichier

name (chaîne de caractères, requis) : Le nom par défaut du thème lors de son installation. Ceci peut être modifié par les administrateurs après l’installation du thème.

component (booléen, défaut false) : si le thème doit être traité comme un composant.

license_url (chaîne de caractères, optionnel) : une URL vers un fichier de licence. Un lien vers celui-ci sera affiché dans l’interface d’administration. La plupart des thèmes l’utilisent pour lier à leur fichier de licence sur GitHub.

about_url (chaîne de caractères, optionnel) : une URL contenant plus d’informations sur le thème. Un lien vers celui-ci sera affiché dans l’interface d’administration. La plupart des thèmes l’utilisent pour lier à leur sujet sur Meta.

authors (chaîne de caractères, optionnel) : Une chaîne de caractères décrivant l’auteur du thème. Affiché dans l’interface d’administration.

theme_version (chaîne de caractères, optionnel) : Une chaîne de caractères arbitraire décrivant la version du thème. Affiché dans l’interface d’administration.

screenshots (tableau, optionnel) : Jusqu’à deux chemins de capture d’écran qui seront utilisés dans diverses parties de l’interface utilisateur pour afficher des captures d’écran du thème. Voir ci-dessous pour plus de détails sur les restrictions.

minimum_discourse_version (chaîne de caractères, optionnel) : la version de discourse la plus ancienne avec laquelle ce thème est compatible. Si elle ne correspond pas, le thème sera automatiquement désactivé. Devrait être au format 2.4.0.beta1.

maximum_discourse_version (chaîne de caractères, optionnel) : la version de discourse la plus récente avec laquelle ce thème est compatible. Si elle ne correspond pas, le thème sera automatiquement désactivé. Devrait être au format 2.4.0.beta1.

Fichiers de localisation (par exemple en.yml) :link: informations sur le format de fichier

theme_metadata.description : Une description localisée du thème. Affichée dans l’interface d’administration.

theme_metadata.settings.setting_name : Une description localisée de setting_name, affichée sous le paramètre du thème dans le panneau d’administration.

Captures d’écran

Les thèmes et les composants peuvent définir un maximum de deux captures d’écran dans la clé screenshots de about.json, ce qui ressemblerait à ceci :

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

Gardez ces restrictions à l’esprit :

  • Les captures d’écran doivent se trouver dans un dossier screenshots dans le dépôt GitHub du thème
  • Taille de fichier max : 1 MB
  • Résolution max : 3840×2160 (4K)
  • Ratio recommandé : 16:9
  • Formats autorisés : .webp, .png, .jpeg, .jpg

Nous suivons également une convention consistant à inclure des captures d’écran light et dark.


Ce document est contrôlé par version - suggérez des modifications sur github.

14 « J'aime »