Support and Documentation

Building a theme

Procedure. To build a theme:
  1. Change to the directory you cloned from github.

    . 1 ├── ├── _build/ │ └── 2 ├── 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. If you want to build the theme and run the Styleguide server, run yarn server:styleguide.

  3. 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.