为主题添加元数据和屏幕截图

您可以向主题添加各种元数据。有些存储在 about.json 文件中,有些存储在语言环境(locale)文件中。

about.json :link: 文件格式信息

name (字符串,必需):安装主题时的默认名称。管理员可以在主题安装后更改此名称。

component (布尔值,默认 false): 主题是否应被视为组件。

license_url (字符串,可选):许可证文件的 URL。此链接将显示在管理界面中。大多数主题使用此链接指向其在 GitHub 上的许可证文件。

about_url (字符串,可选):包含有关主题更多信息的 URL。此链接将显示在管理界面中。大多数主题使用此链接指向其在 Meta 上的主题帖。

authors (字符串,可选):用于描述主题作者的字符串。显示在管理界面中。

theme_version (字符串,可选):用于描述主题版本的任意字符串。显示在管理界面中。

screenshots (数组,可选):最多两个截图路径,将用于 UI 的不同位置以显示主题的截图。有关限制的更多详细信息,请参阅下文。

minimum_discourse_version (字符串,可选):此主题兼容的最早的 Discourse 版本。如果不匹配,主题将被自动禁用。应采用 2.4.0.beta1 格式。

maximum_discourse_version (字符串,可选):此主题兼容的最新的 Discourse 版本。如果不匹配,主题将被自动禁用。应采用 2.4.0.beta1 格式。

语言环境文件 (例如 en.yml) :link: 文件格式信息

theme_metadata.description: 主题的本地化描述。显示在管理界面中。

theme_metadata.settings.setting_name: setting_name 的本地化描述,显示在管理面板中主题设置的下方。

截图

主题和组件可以在 about.jsonscreenshots 键中定义_最多两个截图_,其外观如下:

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

请记住以下限制:

  • 截图必须位于主题 GitHub 仓库的 screenshots 文件夹中
  • 最大文件大小:1 MB
  • 最大分辨率:3840×2160 (4K)
  • 推荐比例:16:9
  • 允许的格式:.webp, .png, .jpeg, .jpg

我们还遵循包含 lightdark 截图的约定。


本文档是版本控制的 - 在 github 上建议更改。

14 个赞