テーマにメタデータとスクリーンショットを追加する

テーマにはさまざまな種類のメタデータを追加できます。一部は about.json ファイルに保存され、一部はロケールファイルに保存されます。

about.json :link: ファイル形式情報

name (文字列、必須): インストール時のテーマのデフォルト名。これは、テーマがインストールされた後に管理者が変更できます。

component (ブール値、デフォルト false): テーマをコンポーネントとして扱うかどうか。

license_url (文字列、オプション): ライセンスファイルへの URL。管理インターフェースにこのリンクが表示されます。ほとんどのテーマは、GitHub のライセンスファイルへのリンクとしてこれを使用します。

about_url (文字列、オプション): テーマに関する詳細情報を含む URL。管理インターフェースにこのリンクが表示されます。ほとんどのテーマは、Meta トピックへのリンクとしてこれを使用します。

authors (文字列、オプション): テーマの作成者を説明する文字列。管理インターフェースに表示されます。

theme_version (文字列、オプション): テーマのバージョンを説明する任意の文字列。管理インターフェースに表示されます。

screenshots (配列、オプション): テーマのスクリーンショットを表示するために UI のさまざまな場所で使用される、最大 2 つのスクリーンショットパス。詳細については、以下を参照してください。

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 キーで最大 2 つのスクリーンショットを定義でき、次のようになります。

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

これらの制限事項に注意してください。

  • スクリーンショットは、テーマの GitHub リポジトリの screenshots フォルダ内にある必要があります
  • 最大ファイルサイズ: 1 MB
  • 最大解像度: 3840×2160 (4K)
  • 推奨比率: 16:9
  • 許可される形式: .webp, .png, .jpeg, .jpg

また、lightdark の両方のスクリーンショットを含めるという慣習に従っています。


このドキュメントはバージョン管理されています - 変更をgithubで提案してください。

「いいね!」 14