テーマを作る
テーマを作る
PureBuilder Simplyのテーマはプロジェクトテンプレートであり、基本的にテーマディレクトリ全体がソースドキュメントルートとしてコピーされます。
テーマディレクトリは.theme.yaml
を含んでいる必要があります。
.theme.yaml
はテーマに関する情報を持ちます。
キー | 値 |
---|---|
name |
テーマ名 |
author |
テーマの作者名 |
description |
テーマの説明 |
initial_control |
インストールで追加で行う処理 |
initial_control
のbuild_cpr
は指定されたソースドキュメントルート上のファイルをビルドドキュメントルートへコピーします。
値は文字列配列の配列です。例えば
initial_control:
build_cpr:
- [foo, bar]
とすると、Source/foo/bar
をBuild/bar
としてコピーします。
initial_control.build_mkdirp
は指定されたディレクトリをソースドキュメントルート上に作成します。
再帰的に作成されるため、事前に上位のディレクトリを用意しておく必要はありません。
initial_control.base_theme
が指定されている場合、テーマインストール時にこのテーマをインストールする前にベーステーマをソースへコピーします。
テーマを公開する
テーマはGitHubなど、あなたの好きな場所に公開することができます。
テーマを投稿する
pbsimply-themes-contributeリポジトリは公式のサードパーティテーマのリポジトリであり、このリポジトリにあるものはPureBuilder SimplyのRubyGemsにバンドルされます。
あなたが作った自信作のテーマをこのリポジトリに対してプルリクエストすることで、多くのPureBuilder Simplyユーザーがデフォルトで選択できるテーマのひとつにするチャンスがあります。 ただし、このリポジトリに採用されるためには、以下の基準を満たす必要があります
name
は[A-Za-z0-9_.]
で構成され、24バイト以下であることdescription
は英語で、簡潔な説明になっていること- テーマは
<processor>/<name>
になるように配置すること - ファイル名は
[A-Za-z0-9_.-]
で構成され、128バイト以下であること - テーマが外部との通信を行わないこと
- 外部ライブラリの導入など、テーマを使用するために通常のインストール以外の作業を要求しないこと
- テーマは
LICENSE
またはLICENSE.txt
ファイルを持ち、Apache License 2.0と共存できるライセンスを採用すること