Brightspot CMS Developer Guide

Configuring a theme

Configuration files define properties which impact the way a theme interacts with Brightspot and Styleguide. Configurations may impact the behavior of your theme during development or at run time.

Configuration files may be defined at the root of your styleguide/directory or in a subdirectory. When placed in a subdirectory it is a best practice to keep your configuration local to the components in the same directory. If you accidentally define a configuration for a component outside of the same directory, Styleguide will try to warn you.

The global configuration is located at the root of your styleguide/ directory:

├── package.json 
└── styleguide/
    ├── _config.json 
    ├── component_directory_1/
    └── component_directory_2/
  • Required
  • Global configuration

If you’d like to separate your configuration into component-specific configuration files, you can add includes to your global _config.json and use glob syntax:

  "includes": [

Now you are able to define additional configuration files in the following manner:

├── package.json 
└── styleguide/
    ├── _config.json 
    └── component/
        ├── Component.hbs
        └── _Component.config.json 
  • Required
  • Global configuration
  • Component configuration

See also:

Previous Topic
Contextual rendering
Next Topic
Image sizes
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
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

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

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

Google Analytics
Apple News