48

Product support

Visit this product's website for support.

Categories

Starter development template for building UIkit v3 themed OctoberCMS sites.

Includes:

Installation

Add the theme to existing project while logged into OctoberCMS account online, or interactively by searching it inside Settings/System/Updates/Themes in backend, or with the following command-line instructions inside project root:

php artisan theme:install castus.ui3kit ui3kit
php artisan theme:use ui3kit

One-time Development Environment Setup

Install NodeJS and Node Package Manager globally (LTS version required). Run the following command-line instructions inside theme root:

npm install --global gulp-cli
npm i

Integrating build process into OctoberCMS project is easy - copy (or merge into existing) files into project root:

gulpfile.js
package.json

Adjust paths.root configuration variable to themes/castus-ui3kit/ and start using command-line tasks from project root.

Using and Editing

Check intro page for example HTML page structure and mandatory includes. Development changes can be automated with command-line instruction from configured Gulpfile (project or theme) build root:

gulp watch

Build versioned, optimized, minified, autoprefixed assets with command-line instruction:

gulp upbuild --production

Customizing UIkit Styles

Override global framework/theme styling parameters in the following SCSS files, just don't forget to remove !default from variables:

Comment out unwanted components/theming for leaner and faster UIkit custom build:

For in-depth customizations and optimizations follow the SASS docs.

Including Custom JavaScript

Use Gulp-include plugin to require JavaScript source files from anywhere in paths.include.js hierarchy, example:

1.6.3

Upgraded SCSS imports and UIkit framework to 3.1.6, updated build dependencies

Jun 20, 2019

1.6.2

Upgraded SCSS imports and UIkit framework to 3.1.5, updated NPM dependencies

May 18, 2019

1.6.1

Upgraded SCSS imports and UIkit framework to 3.1.4, documented gulp-include

May 10, 2019

1.6.0

Upgraded SCSS imports and UIkit framework to 3.1.3, upgraded deprecated styles

Apr 23, 2019

1.5.1

Upgraded UIkit framework to 3.0.3, optimized asset loading

Jan 30, 2019

1.5.0

Upgraded SCSS imports and UIkit framework to 3.0.2, removed Yarn

Jan 16, 2019

1.4.1

Upgraded SCSS imports and UIkit framework to 3.0.0-RC.26

Jan 10, 2019

1.4.0

Upgraded SCSS imports and UIkit framework to 3.0.0-RC.25, replaced gulp-imagemin with gulp-responsive

Dec 17, 2018

1.3.0

Upgraded SCSS imports and UIkit framework to 3.0.0-RC.10, rebuilt assets

Jul 25, 2018

1.2.2

Upgraded UIkit framework to 3.0.0-Beta.42, rebuilt assets

Apr 06, 2018

1.2.1

Reintroduced custom SCSS variables partial, added mixin override example

Mar 17, 2018

1.2.0

Split themed framework build from base, added NPM scripts

Mar 16, 2018

1.1.1

Added style guide

Mar 13, 2018

1.1.0

Refactored Gulp build to use NPM package configuration (with "not dead" browserslist)

Mar 12, 2018

1.0.1

Upgraded Gulp build with image optimization task

Mar 10, 2018

1.0.0

Initial UI3kit theme (framework version 3.0.0-Beta.40) with Gulp build

Mar 05, 2018