Brightspot CMS Developer Guide

Building a theme


To build a theme:

  1. Change to the theme directory you cloned from github.
    . 
    ├── README.md
    ├── _build/
    │   └── brightspot-theme-frost-x.x.x-SNAPSHOT.zip
    ├── babel.config.js
    ├── com/
    ├── etc/
    ├── gulpfile.js
    ├── node_modules/
    ├── package.json
    ├── postcss.config.js
    ├── styleguide/
    ├── webpack.*.js
    └── yarn.lock
    • Directory from which you run the build or start the server.
    • Built theme.
  2. Ensure you have version 12 or later of node installed: nvm ls. Install version 12 or later if necessary from nodejs.org.
  3. Use a version 12 or later release of node: nvm use xx.x.x (use the version you discovered in step 2).
  4. If you want to build the theme and run the Styleguide server, run yarn server:styleguide.
  5. If you want to build the theme without running the Styleguide server—
    • For the first build, run yarn cache clean && yarn && yarn format && yarn build.
    • For subsequent builds, run yarn build.

The build job creates and zips the theme in the directory build/ (see previous illustration). You can apply the built theme to a site; for details, see Changing a site's theme.

Previous Topic
Swatches
Next Topic
Advanced theming techniques
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Content types
Modules
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Dashboards
Publishing
Workflows
Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
Images
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Shopify
Apple News