guide_ja.md

ガイド

この文書では、プロファイルのフォルダ名を{プロファイル名}、ファイル名を{ファイル名}と表記します。

サーバー管理者向け

導入方法

独自の導入方法を指定しているリソースは、その方法に従ってください。

プラグイン

1. scssファイルをダウンロードまたはクローンします。
2. Mastodon Materialのpluginsフォルダにそのファイルを移動します。
3. profiles/{プロファイル名}/plugins.scssに次のように追記してください。

   @import '../../plugins/{ファイル名}';

配色

1. scssファイルをダウンロードまたはクローンします。
2. Mastodon Materialのcolorフォルダにそのファイルを移動します。
3. profiles/{プロファイル名}/config.scssに次のように追記してください。

   @import '../../color/{ファイル名}';

レイアウト

1. scssファイルをダウンロードまたはクローンします。
2. Mastodon Materialのlayoutフォルダにそのファイルを移動します。
3. profiles/{プロファイル名}/config.scssに次のように追記してください。

   @import '../../layout/{ファイル名}';

アップデート

各手順の2で導入したファイルを、最新のものに置き換えます。
一部のリソースでは、アップデートの案内がコンソールに表示されることがあります。

開発者向け

変数について

利用できる変数はcolor/v1-light.scssやlayout/material-v2.scssなどの公式リソースを参照してください。

フォールバック

バージョンアップや仕様変更により互換性が失われた場合に、公式のリソースを使ってフォールバックすると、互換性の問題を緩和できることがあります。scssファイルの先頭に、以下のように記述してください。参照はファイルの配置に合わせて適宜変更してください。

配色

@import '../color/{ファイル名}';

レイアウト

@import '../layout/{ファイル名}';

プラグインのターゲットバージョンを指定する

Mastodon Materialのバージョンと、プラグインのターゲットバージョンが異なる場合に、コンソールにメッセージを表示させることができます。scssファイルの先頭に以下のように記述してください。

$name: "プラグイン名";  // プラグイン名
$plugin-version: "1.0.0";  // プラグインのバージョン
$target-version: "1.0.0";  // theme/theme.scssの$versionを確認
$website: "";  // ウェブサイトまたはダウンロードURL
@include version-check($name, $plugin-version, $target-version, $website);

貢献の方法

製作したリソースをこのリポジトリに載せる場合、以下の様式に従ってプルリクエストを開いてください。

• 最低限、リソース名、説明(言語の種類、数は問わない)、バージョンをプルリクエストのコメントに記述してください。README.mdに載ります。スクリーンショットを1枚まで含めることができます。
• ファイルが複数ある場合、1つのフォルダに入れてください。階層は自由です。
• scssファイルのほかに、以下のファイルを含めることができます。
  • README
  • スクリーンショット
  • LICENSEファイル