テーマとテーマコンポーネントの構造

Discourse は、.tar.gz アーカイブまたはリモート Git リポジトリ(プライベートリポジトリを含む)から取得できる ネイティブテーマ をサポートしています。

テーマの例:GitHub - discourse/discourse-simple-theme: Sam's simple discourse theme · GitHub

Git リポジトリは更新がチェックされます(1 日 1 回)、または 更新を確認 ボタンを使用してチェックできます。変更が検出されると、更新を確認 ボタンが 最新バージョンに更新 に変わります。

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": "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"]
}

テーマに設定を追加する方法については、こちらをご覧ください: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