Create theme
Create theme
PureBuilder Simply themes are project templates and basically the entire theme directory is copied as the source document root.
The theme directory must contain .theme.yaml
.
The .theme.yaml
contains information about the
theme.
Key | Value |
---|---|
name |
Name of theme |
author |
Name of author |
description |
Theme summery |
initial_control |
Additional action in appling theme |
The build_cpr
of initial_control
copies files on the specified source document root to the build
document root. The value is an array of string arrays. For
example
initial_control:
build_cpr:
- [foo, bar]
would copy Source/foo/bar
as
Build/bar
.
initial_control.build_mkdirp
creates the
specified directory on the source document root. Since it is
created recursively, there is no need to prepare a parent
directory in advance.
initial_control.base_theme
sets “base theme”. If
it’s set, copy base theme into document source directory before
installing this theme.
Publish theme
You can publish anywhere you want (e.g. GitHub.)
Contribute theme
The pbsimply-themes-contribute repository is the official third-party theme repository, Anything in this repository will be bundled with PureBuilder Simply’s RubyGems.
By making a pull request to this repository for a theme that you are confident in creating, you have the opportunity to make it one of the default choices for many PureBuilder Simply users. However, to be accepted into this repository, your theme must meet the following criteria
name
must consist of[A-Za-z0-9_.]
and less than or equal to 24 bytes- The
description
must be in English and be a concise description - Themes should be placed so that they are
<processor>/<name>
. - The file name should consist of
[A-Za-z0-9_.-]
and must be less than or equal to 128 bytes. - The theme must not communicate with the outside world.
- The theme does not require any work other than normal installation to use it, such as installing external libraries.
- The theme must have a
LICENSE
orLICENSE.txt
file and adopt a license that can coexist with the Apache License 2.0