Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.41 KB

development.md

File metadata and controls

67 lines (45 loc) · 2.41 KB

Starter Theme Development Instructions

The starter theme was created by WebMan Design. Please read the instructions below for theme development process.

Additional scripts

This starter theme requires installation of these additional scripts:

Replacements

When developing a new theme, you need to batch replace a predefined set of string variables. Each variable is enclosed in {%= %} brackets (i.e. {%= variable_name %}).

Example replacements:

Prefix variable Value
theme_name Theme Name
theme_slug themeslug
version_since 1.0.0 (http://semver.org/ recommended)
version 1.0.0 (http://semver.org/ recommended)
prefix_constant THEMESLUG
prefix_var themeslug
prefix_class Themeslug
prefix_fn themeslug
prefix_js themeslug
prefix_hook_fn themeslug
prefix_hook themeslug
text_domain themeslug

Project replacements:

Developers, fill this section with the actual values used for replacements for future reference.

Prefix variable Value
theme_name Reykjavik
theme_slug reykjavik
version_since 1.0.0
version 1.0.0
prefix_constant REYKJAVIK
prefix_var reykjavik
prefix_class Reykjavik
prefix_fn reykjavik
prefix_js reykjavik
prefix_hook_fn reykjavik
prefix_hook reykjavik
text_domain reykjavik

Documentation

The theme documentation template can be found in documentation subfolder. Documentation uses the theme_name, theme_slug, version_since and version from above to be replaced.

Upgrades

In case you upgrade the library (library/*.*) and/or other universal pluggable/external scripts, such as CSS starter (assets/scss/starter), you will need to batch replace certain string variables (see above).

Reference of what variables need to be replaced can be found in the scripts themselves.

(C) WebMan Design, Oliver Juhas, [https://www.webmandesign.eu]