Starter development template for building UIkit v3 themed OctoberCMS sites.
Includes:
- latest UIkit ^3.19 source from official repository
- style guide layout with most UI components
- GulpJS-based build system for development and production
- NPM-based config system for development and production
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 preferred for Gulp ^3). 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:
- assets/scss/uikit3 SCSS
- assets/scss/_components-variables SCSS
- assets/scss/uikit3themed SCSS
- assets/scss/_theme-variables SCSS
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:
| 3.6.1 |
Upgraded UIkit framework to 3.19.4, updated NPM dependencies Apr 09, 2024 |
|---|---|
| 3.6.0 |
Upgraded UIkit framework to 3.19.2, updated SCSS variables Mar 12, 2024 |
| 3.5.1 |
Upgraded UIkit framework to 3.18.3, restored OCv2 framework extras Feb 14, 2024 |
| 3.5.0 |
Upgraded UIkit framework to 3.18.1, updated NPM dependencies and SCSS variables Feb 07, 2024 |
| 3.4.3 |
Upgraded UIkit framework to 3.17.8, fixed uk-countdown styleguide Nov 17, 2023 |
| 3.4.2 |
Upgraded UIkit framework to 3.17.8, added utility styles Nov 02, 2023 |
| 3.4.1 |
Upgraded UIkit framework to 3.17.5, deprecated JS functions Oct 25, 2023 |
| 3.4.0 |
Upgraded UIkit framework to 3.17.2, updated SCSS variables Oct 17, 2023 |
| 3.3.2 |
Upgraded UIkit framework to 3.16.27, Modernizr to 3.13.0 Sep 29, 2023 |
| 3.3.1 |
Upgraded UIkit framework to 3.16.24, fixed styleguide combiner Aug 03, 2023 |
| 3.3.0 |
Upgraded UIkit framework to 3.16.23, cleaned up ignored files Jul 31, 2023 |
| 3.2.5 |
Upgraded UIkit framework to 3.16.23, cleaned up ignored files Jul 27, 2023 |
| 3.2.4 |
Upgraded UIkit framework to 3.16.19, rebuilt assets May 26, 2023 |
| 3.2.3 |
Upgraded UIkit framework to 3.16.16, updated NPM dependencies May 08, 2023 |
| 3.2.2 |
Upgraded UIkit framework to 3.16.13, rebuilt assets Mar 29, 2023 |
| 3.2.1 |
Upgraded UIkit framework to 3.16.10, updated SCSS variables Mar 20, 2023 |
| 3.2.0 |
Upgraded UIkit framework to 3.16.3, updated NPM dependencies, imports and SCSS variables Feb 27, 2023 |
| 3.1.1 |
Upgraded UIkit framework to 3.15.24, updated SCSS variables Feb 10, 2023 |
| 3.1.0 |
Upgraded UIkit framework to 3.15.21, updated imports and SCSS variables Jan 12, 2023 |
| 3.0.9 |
Upgraded UIkit framework to 3.15.18, increased supported iOS version Dec 13, 2022 |
| 3.0.8 |
Upgraded UIkit framework to 3.15.15, switched to native sticky Dec 02, 2022 |
| 3.0.7 |
Upgraded UIkit framework to 3.15.13, rebuilt assets Nov 18, 2022 |
| 3.0.6 |
Upgraded UIkit framework to 3.15.11, improved compatibility with v2+ backend Oct 28, 2022 |
| 3.0.5 |
Upgraded UIkit framework to 3.15.10, rebuilt assets Sep 23, 2022 |
| 3.0.4 |
Upgraded UIkit framework to 3.15.8, updated NPM dependencies Sep 15, 2022 |
| 3.0.3 |
Upgraded UIkit framework to 3.15.5, rebuilt assets Aug 26, 2022 |
| 3.0.2 |
Upgraded UIkit framework to 3.15.3, updated SCSS variables Aug 12, 2022 |
| 3.0.1 |
Upgraded UIkit framework to 3.15.1, updated style guide Jul 18, 2022 |
| 3.0.0 |
Upgraded UIkit framework to 3.15.0, updated imports, removed responsive images Gulp task Jul 18, 2022 |
| 2.1.0 |
Upgraded UIkit framework to 3.14.3, updated SCSS variables May 31, 2022 |
| 2.0.4 |
Upgraded UIkit framework to 3.13.7, rebuilt assets Apr 01, 2022 |
| 2.0.3 |
Upgraded UIkit framework to 3.13.4, updated SCSS variables Mar 25, 2022 |
| 2.0.2 |
Upgraded UIkit framework to 3.13.1, rebuilt assets Mar 18, 2022 |
| 2.0.1 |
Upgraded UIkit framework to 3.12.2, Modernizr to 3.12.0 Mar 15, 2022 |
| 2.0.0 |
Upgraded UIkit framework to 3.12.1, removed IE11 support, updated SCSS variables Mar 14, 2022 |
| 1.24.0 |
Upgraded UIkit framework to 3.11.1, updated NPM dependencies Feb 11, 2022 |
| 1.23.1 |
Upgraded UIkit framework to 3.10.1, rebuilt assets Jan 19, 2022 |
| 1.23.0 |
Upgraded UIkit framework to 3.10.0, updated SCSS variables and NPM dependencies Jan 12, 2022 |
| 1.22.0 |
Upgraded UIkit framework to 3.9.3, updated SCSS variables Nov 19, 2021 |
| 1.21.1 |
Upgraded UIkit framework to 3.8.1, rebuilt assets Nov 05, 2021 |
| 1.21.0 |
Upgraded UIkit framework to 3.8.0, updated SCSS variables and NPM dependencies Nov 05, 2021 |
| 1.20.5 |
Upgraded UIkit framework to 3.7.6, rebuilt assets Oct 14, 2021 |
| 1.20.4 |
Upgraded UIkit framework to 3.7.5, updated NPM dependencies Oct 07, 2021 |
| 1.20.3 |
Upgraded UIkit framework to 3.7.4, rebuilt assets Oct 07, 2021 |
| 1.20.2 |
Upgraded UIkit framework to 3.7.3, updated SCSS variables and NPM dependencies Oct 07, 2021 |
| 1.20.1 |
Upgraded UIkit framework to 3.7.2, rebuilt assets Oct 07, 2021 |
| 1.20.0 |
Upgraded UIkit framework to 3.7.1, updated SCSS variables and pinned compilation to LibSASS Jul 15, 2021 |
| 1.19.1 |
Upgraded UIkit framework to 3.6.22, rebuilt assets May 18, 2021 |
| 1.19.0 |
Updated NPM dependencies for NodeJS 14.x compatibility May 18, 2021 |
| 1.18.1 |
Upgraded UIkit framework to 3.6.21, updated SCSS variables May 05, 2021 |
| 1.18.0 |
Upgraded UIkit framework to 3.6.20, Modernizr to 3.11.7; added composer.json Apr 23, 2021 |
| 1.17.2 |
Upgraded UIkit framework to 3.6.19, Modernizr to 3.11.6; updated SCSS variables Apr 07, 2021 |
| 1.17.1 |
Upgraded UIkit framework to 3.6.18, updated NPM dependencies Mar 12, 2021 |
| 1.17.0 |
Upgraded UIkit framework to 3.6.17, rebuilt assets Feb 26, 2021 |
| 1.16.9 |
Upgraded UIkit framework to 3.6.16, updated NPM dependencies Feb 26, 2021 |
| 1.16.8 |
Upgraded UIkit framework to 3.6.14, rebuilt assets Feb 26, 2021 |
| 1.16.7 |
Upgraded UIkit framework to 3.6.13, updated NPM dependencies Jan 21, 2021 |
| 1.16.6 |
Upgraded UIkit framework to 3.6.11, rebuilt assets Jan 11, 2021 |
| 1.16.5 |
Upgraded UIkit framework to 3.6.9, updated NPM dependencies Jan 08, 2021 |
| 1.16.4 |
Upgraded UIkit framework to 3.6.7, rebuilt assets Jan 05, 2021 |
| 1.16.3 |
Upgraded UIkit framework to 3.6.6, updated NPM dependencies Jan 04, 2021 |
| 1.16.2 |
Upgraded UIkit framework to 3.6.5, rebuilt assets Dec 21, 2020 |
| 1.16.1 |
Upgraded UIkit framework to 3.6.1, rebuilt assets Dec 18, 2020 |
| 1.16.0 |
Upgraded UIkit framework to 3.6.0, updated NPM dependencies Dec 17, 2020 |
| 1.15.7 |
Upgraded UIkit framework to 3.5.17, rebuilt assets Dec 16, 2020 |
| 1.15.6 |
Upgraded UIkit framework to 3.5.16, rebuilt assets Dec 11, 2020 |
| 1.15.5 |
Upgraded UIkit framework to 3.5.14, rebuilt assets Dec 10, 2020 |
| 1.15.4 |
Upgraded UIkit framework to 3.5.13, updated NPM dependencies Dec 09, 2020 |
| 1.15.3 |
Upgraded UIkit framework to 3.5.12, rebuilt assets Dec 08, 2020 |
| 1.15.2 |
Upgraded UIkit framework to 3.5.11, updated NPM dependencies Dec 07, 2020 |
| 1.15.1 |
Updated NPM dependencies for NodeJS 12.x compatibility Dec 03, 2020 |
| 1.15.0 |
Replaced Gulp CSS processing with PostCSS and plugins, upgraded UIkit to 3.5.10 Nov 27, 2020 |
| 1.14.4 |
Upgraded UIkit framework to 3.5.9, rebuilt assets Oct 21, 2020 |
| 1.14.3 |
Upgraded UIkit framework to 3.5.8, updated SCSS variables Sep 28, 2020 |
| 1.14.2 |
Upgraded UIkit framework to 3.5.7, updated NPM dependencies Aug 27, 2020 |
| 1.14.1 |
Upgraded UIkit framework to 3.5.6, updated SCSS imports Aug 14, 2020 |
| 1.14.0 |
Upgraded UIkit framework to 3.5.5, Modernizr to 3.11.3; updated SCSS imports and variables Jul 15, 2020 |
| 1.13.1 |
Upgraded UIkit framework to 3.5.4, rebuilt assets Jun 12, 2020 |
| 1.13.0 |
Added social links; upgraded UIkit framework to 3.5.3, Modernizr to 3.11.2, NPM dependencies Jun 02, 2020 |
| 1.12.4 |
Upgraded UIkit framework to 3.4.6, rebuilt assets May 12, 2020 |
| 1.12.3 |
Upgraded UIkit framework to 3.4.4, Modernizr to 3.11.1 May 07, 2020 |
| 1.12.2 |
Upgraded UIkit framework to 3.4.2, rebuilt assets Apr 22, 2020 |
| 1.12.1 |
Upgraded UIkit framework to 3.4.1, rebuilt assets Apr 17, 2020 |
| 1.12.0 |
Upgraded UIkit framework to 3.4.0, Modernizr to 3.10.0 Apr 14, 2020 |
| 1.11.3 |
Upgraded UIkit framework to 3.3.7, rebuilt assets Mar 19, 2020 |
| 1.11.2 |
Upgraded UIkit framework to 3.3.3, rebuilt assets Feb 26, 2020 |
| 1.11.1 |
Upgraded UIkit framework to 3.3.2, Modernizr to 3.9.1 Feb 19, 2020 |
| 1.11.0 |
Upgraded UIkit framework to 3.3.1, Modernizr to 3.9.0; updated SCSS variables Feb 05, 2020 |
| 1.10.0 |
Upgraded UIkit framework to 3.3.0, rebuilt assets Jan 27, 2020 |
| 1.9.1 |
Upgraded UIkit framework to 3.2.7, rebuilt assets Jan 15, 2020 |
| 1.9.0 |
Replaced vendor Modernizr with NPM configuration and build script Jan 08, 2020 |
| 1.8.2 |
Upgraded UIkit framework to 3.2.6, fixed BrowsersList override Dec 18, 2019 |
| 1.8.1 |
Upgraded UIkit framework to 3.2.4, updated NPM dependencies Dec 05, 2019 |
| 1.8.0 |
Upgraded UIkit framework to 3.2.3, updated NodeJS and NPM dependencies Nov 06, 2019 |
| 1.7.1 |
Upgraded UIkit framework to 3.2.1, rebuilt assets Oct 04, 2019 |
| 1.7.0 |
Upgraded UIkit framework to 3.2.0, updated SCSS variables Sep 19, 2019 |
| 1.6.5 |
Upgraded UIkit framework to 3.1.9, updated NPM dependencies Sep 04, 2019 |
| 1.6.4 |
Upgraded UIkit framework to 3.1.7, updated NPM dependencies Aug 21, 2019 |
| 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, updated 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 core, 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 |