drupalwxt / wxt_bootstrap

Bootstrap derived sub-theme aligned for use with the Web Experience Toolkit jQuery Framework.
8 stars 3 forks source link
bootstrap drupal theme wxt

WxT Bootstrap

A modern, component based and accessible theme powered by the Bootstrap base theme and integrated extensively with the WxT jQuery Framework.

This theme will strive to always work with the native Drupal 8 workflow which consists of leveraging block layouts and twig templates by default. Over time full support for various contributed modules such as Display Suite and Panels will be added for more complex layout functionality.

Note: For up-to-date documentation please always consult our README.md file.

Installation

There are two possible installation methods to leverage the WxT Bootstrap theme in Drupal 8:

The standalone install is provided as an additional installation method for those who do not wish to have the full weight of a distribution and its required dependencies.

Distribution

All dependencies are included as part of the Drupal WxT distribution and come completely configured alongside with additional integrations and workflow improvements.

Note: We heavily recommend that you use the distribution method. Limited support is provided for standalone.

  • Extra configuration of WxT components and additional custom plugins
  • Drupal application lifecycle and timely updates of core
  • Workflow improvements and configuration of key contributed modules

StandAlone

WxT Bootstrap at a minimum requires the following dependencies:

Note: The wet-boew assets need to be under the /libraries folder with the proper naming scheme.

You can easily retrieve these dependencies via composer:

composer require drupal/wxt_bootstrap
composer require drupal/wxt_library

Note: Please take a look at the composer.json file located in WxT Library which pulls in all of the theme assets using a custom composer repository.

Setup

Enable either The WxT Bootstrap theme or derived sub-theme and set it to be the default active theme in Drupal.

Sub-Theming

We provide a starterkit under the starterkits folder that contains the template for inheriting from wxt_bootstrap.

Note: In order for your new sub-theme to inherit styles (and maybe other things) from the wxt_bootstrap base theme you need to select your new sub-theme under the Theme Visibility settings (/admin/config/wxt/wxt_library).

SCSS Compilation

You will need to have the following required dependencies for the following commands to execute successfully:

Inside the theme directory run the following to install the required NodeJS dependencies:

yarn install

Pre-requisites

Download and extract the latest 3.x.x version of Bootstrap Framework Source Files into the root of your new sub-theme. After it has been extracted, the directory should be renamed (if needed) so it reads ./wxt_bootstrap/libraries/bootstrap. Even though WxT ships with the compiled bootstrap files as libraries we still need the source files to compile the bootstrap overrides.

With Gulp

Run the following commands inside the theme directory to compile SCSS to CSS: