主题与主题组件的结构

Discourse 支持原生主题,这些主题可以来自 .tar.gz 归档文件或远程 Git 仓库,包括私有仓库

示例主题位于:GitHub - discourse/discourse-simple-theme: Sam's simple discourse theme · GitHub

Git 仓库将每天检查一次更新(每天一次),或者通过点击检查更新 按钮来手动检查。当检测到更改时,检查更新 按钮将变为更新到最新版本

image

创建主题时,需要遵循特定的文件结构。以下是您可以包含的文件:

about.json(必需)

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}.gjs
javascripts/{anything}.hbs

assets/{asset_filename}

settings.yml

上述 :arrow_up: 中的所有文件都是可选的,因此您只需创建所需的文件即可。

对于希望将主题 SCSS 拆分为多个文件的用户,现在已支持该功能。

对于希望将主题拆分为多个 JS 文件的用户,只需将所需的 JS 文件添加到 javascripts 目录中即可。

about.json 文件结构如下,您可以在 Adding metadata and screenshots to a Theme 查看更多相关信息:

{
  "name": "我的主题",
  "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": {
    "我的配色方案": {
      "primary": "222222"
    }
  },
  "screenshots": ["screenshots/light.jpeg", "screenshots/dark.jpeg"]
}

有关如何为主题添加设置的说明,请参阅:Add settings to your Discourse theme

如果您想添加的是主题组件而非完整主题,只需在 about.json 文件中添加一行 "component": true 即可。

文件结构与主题的自定义 CSS/HTML 相匹配。

进一步阅读

查看带有 #themes::tag 标签的其他文章。

:information_source: 另见:


最后由 @SaraDev2022-08-15T21:00:00Z 审核


本文档受版本控制 - 请在 GitHub 上提出修改建议。

62 个赞
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
Add support for theme settings
Create and share a font theme component
Color Scheme Contest (with Prizes!)
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
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