Load a theme via a theme key in volto.config.js or in package.json

addon-registry.js

@@ -130,6 +130,10 @@ class AddonConfigurationRegistry {
     this.packages = {};
     this.customizations = new Map();
 
+    // Theme from a package.json key or from volto.config.js
+    // Programatically via volto.config.js wins
+    this.theme = packageJson.theme || this.voltoConfigJS.theme;
+
     this.initDevelopmentPackages();
     this.initPublishedPackages();
     this.initAddonsFromEnvVar();
@@ -354,6 +358,35 @@ class AddonConfigurationRegistry {
       .filter((e) => e);
   }
 
+  getCustomThemeAddons() {
+    const customThemeAddonsInfo = {
+      variables: [],
+      main: [],
+    };
+
+    this.getAddonDependencies().forEach((addon) => {
+      const normalizedAddonName = addon.split(':')[0];
+      // We have two possible insertion points, variables and main
+
+      const customThemeVariables = `${this.packages[normalizedAddonName].modulePath}/theme/_variables.scss`;
+      const customThemeMain = `${this.packages[normalizedAddonName].modulePath}/theme/_main.scss`;
+      if (
+        fs.existsSync(customThemeVariables) &&
+        normalizedAddonName !== this.theme
+      ) {
+        customThemeAddonsInfo.variables.push(normalizedAddonName);
+      }
+      if (
+        fs.existsSync(customThemeMain) &&
+        normalizedAddonName !== this.theme
+      ) {
+        customThemeAddonsInfo.main.push(normalizedAddonName);
+      }
+    });
+
+    return customThemeAddonsInfo;
+  }
+
   /**
    * Returns a mapping name:diskpath to be uses in webpack's resolve aliases
    */

create-theme-addons-loader.js

@@ -0,0 +1,79 @@
+const path = require('path');
+const fs = require('fs');
+const tmp = require('tmp');
+const cryptoRandomString = require('crypto-random-string');
+
+const titleCase = (w) => w.slice(0, 1).toUpperCase() + w.slice(1, w.length);
+
+/*
+ * Transforms a package name to javascript variable name
+ */
+function nameFromPackage(name) {
+  name =
+    name.replace(/[@~./\\:\s]/gi, '') ||
+    cryptoRandomString({ length: 10, characters: 'abcdefghijk' });
+  return name
+    .split('-')
+    .map((w, i) => (i > 0 ? titleCase(w) : w))
+    .join('');
+}
+
+/*
+ * Creates a static file with code necessary to load the addons configuration
+ *
+ */
+function getAddonsLoaderCode(name, customThemeAddons = []) {
+  let buf = `/*
+This file is autogenerated. Don't change it directly.
+Add a ./theme/_${name}.scss in your add-on to load your theme customizations in the current theme.
+*/
+
+`;
+  customThemeAddons.forEach((addon) => {
+    const customization = `${addon}/theme/${name}`;
+    const line = `@import '${customization}';\n`;
+    buf += line;
+  });
+
+  return buf;
+}
+
+module.exports = ({ main, variables }) => {
+  // const addonsThemeLoaderVariablesPath = path.join(
+  //   process.cwd(),
+  //   'src',
+  //   '_variables.scss',
+  // );
+  // const addonsThemeLoaderMainPath = path.join(
+  //   process.cwd(),
+  //   'src',
+  //   '_main.scss',
+  // );
+
+  // const addonsThemeLoaderVariablesPath = path.join(
+  //   process.cwd(),
+  //   'src',
+  //   '_variables.scss',
+  // );
+  // const addonsThemeLoaderMainPath = path.join(
+  //   process.cwd(),
+  //   'src',
+  //   '_main.scss',
+  // );
+
+  const addonsThemeLoaderVariablesPath = tmp.tmpNameSync({ postfix: '.scss' });
+  const addonsThemeLoaderMainPath = tmp.tmpNameSync({ postfix: '.scss' });
+  fs.writeFileSync(
+    addonsThemeLoaderVariablesPath,
+    new Buffer.from(getAddonsLoaderCode('variables', variables)),
+  );
+  fs.writeFileSync(
+    addonsThemeLoaderMainPath,
+    new Buffer.from(getAddonsLoaderCode('main', main)),
+  );
+
+  return [addonsThemeLoaderVariablesPath, addonsThemeLoaderMainPath];
+};
+
+module.exports.getAddonsLoaderCode = getAddonsLoaderCode;
+module.exports.nameFromPackage = nameFromPackage;

docs/source/addons/theme.md

@@ -0,0 +1,206 @@
+---
+myst:
+  html_meta:
+    "description": "Create a theme add-on"
+    "property=og:description": "Create a theme add-on"
+    "property=og:title": "Create a theme add-on"
+    "keywords": "Volto, Plone, Semantic UI, CSS, Volto theme"
+---
+
+# Create a theme add-on
+
+We can create a Volto Add-on that acts as a theme Add-on, so we can detach it from the project.
+The advantage is that you can deploy the same theme in different projects, or have themes depending on conditions that you could inject on build time.
+
+1. Add a `theme` key in your `volto.config.js` file in the root of your project:
+
+```js
+module.exports = {
+  addons: [],
+  theme: 'volto-my-theme'
+};
+```
+or add a key in your `package.json` project:
+
+```json
+"theme": "volto-my-theme"
+```
+
+2. Create a directory `src/theme` in your add-on, then add this file `theme.config`, replacing `<name_of_your_theme>` with your add-on name:
+
+```less
+/*******************************
+        Theme Selection
+*******************************/
+
+/* To override a theme for an individual element specify theme name below */
+
+/* Global */
+@site        : 'pastanaga';
+@reset       : 'pastanaga';
+
+/* Elements */
+@button      : 'pastanaga';
+@container   : 'pastanaga';
+@divider     : 'pastanaga';
+@flag        : 'pastanaga';
+@header      : 'pastanaga';
+@icon        : 'pastanaga';
+@image       : 'pastanaga';
+@input       : 'pastanaga';
+@label       : 'pastanaga';
+@list        : 'pastanaga';
+@loader      : 'pastanaga';
+@placeholder : 'pastanaga';
+@rail        : 'pastanaga';
+@reveal      : 'pastanaga';
+@segment     : 'pastanaga';
+@step        : 'pastanaga';
+
+/* Collections */
+@breadcrumb  : 'pastanaga';
+@form        : 'pastanaga';
+@grid        : 'pastanaga';
+@menu        : 'pastanaga';
+@message     : 'pastanaga';
+@table       : 'pastanaga';
+
+/* Modules */
+@accordion   : 'pastanaga';
+@checkbox    : 'pastanaga';
+@dimmer      : 'pastanaga';
+@dropdown    : 'pastanaga';
+@embed       : 'pastanaga';
+@modal       : 'pastanaga';
+@nag         : 'pastanaga';
+@popup       : 'pastanaga';
+@progress    : 'pastanaga';
+@rating      : 'pastanaga';
+@search      : 'pastanaga';
+@shape       : 'pastanaga';
+@sidebar     : 'pastanaga';
+@sticky      : 'pastanaga';
+@tab         : 'pastanaga';
+@transition  : 'pastanaga';
+
+/* Views */
+@ad          : 'pastanaga';
+@card        : 'pastanaga';
+@comment     : 'pastanaga';
+@feed        : 'pastanaga';
+@item        : 'pastanaga';
+@statistic   : 'pastanaga';
+
+/* Extras */
+@main        : 'pastanaga';
+@custom      : 'pastanaga';
+
+/*******************************
+            Folders
+*******************************/
+
+/* Path to theme packages */
+@themesFolder : '~volto-themes';
+
+/* Path to site override folder */
+@siteFolder  : "~<name_of_your_theme>/theme";
+
+/*******************************
+         Import Theme
+*******************************/
+
+@import (multiple) "~semantic-ui-less/theme.less";
+@fontPath : "~volto-themes/@{theme}/assets/fonts";
+
+.loadAddonOverrides() {
+  @import (optional) "@{siteFolder}/@{addon}/@{addontype}s/@{addonelement}.overrides";
+}
+
+/* End Config */
+```
+
+3. Declare the theme as an add-on by adding its name as the value for the `addons` key in either `volto.config.js` or `package.json`.
+4. After starting Volto, the theme should be active.
+   Now you can add overrides to the default theme in `src/theme`, same as you would in a project.
+5. Now you can safely delete your project's `theme` folder, since the one in the add-on will take precedence.
+
+## Using your own escape hatch
+
+Volto theming uses SemanticUI theming capabilities to define and extend a theme for your site.
+However, while maintaining and playing well with the Semantic UI Volto base, using a traditional CSS approach can be done using the Less-based `extras` escape hatch.
+
+At the same time, one can entirely bail off the extras scape hatch and add your own, by customizing the `theme.js` module in Volto.
+
+```js
+import 'semantic-ui-less/semantic.less';
+import '@plone/volto/../theme/themes/pastanaga/extras/extras.less';
+
+// You can add more entry points for theming
+import '@kitconcept/volto-light-theme/theme/main.scss';
+```
+
+While building your own escape hatch for theming, you can use the preprocessor of your choice (in the example, SCSS) while maintaining the "base" Volto theme, but customizing it using the resultant CSS.
+
+You can see an example of such a theme in: https://github.com/kitconcept/volto-light-theme
+
+## Modify a custom theme from another add-on
+
+Sometimes you have a custom theme that you want to reuse through all your projects, but with some differences, maintaining the base.
+Usually, the only option would be to use an add-on that adds more CSS to the base theme, using imports that will load after the theme.
+However, there is a problem with this approach.
+You cannot use existing theme variables, including breakpoints, on these new styles.
+Similarly, it gets somewhat detached from the normal flow of the loaded theme.
+The same applies for add-ons, as they are detached from the current theme.
+One could use a SemanticUI approach for making this work, but it's SemanticUI bound.
+
+```{warning}
+This is only possible when using your own escape hatch, and works only with SCSS-based themes, and not with SemanticUI themes, since it enables a couple of entry points that only support SCSS files.
+For an example of how it could be used, see: https://github.com/kitconcept/volto-light-theme
+```
+
+If your custom escape hatch defines a custom theme using SCSS, you can take advantage of this feature.
+Although not limited to this, it would be possible to extend this feature to add more entry points, using another preprocessor or theming approach.
+
+This feature enables two entry points: variables and main.
+From your add-on code, you can extend an existing theme by creating a file corresponding to each entry point:
+
+* `./src/theme/_variables.scss`
+* `./src/theme/_main.scss`
+
+### Variables (`addonsThemeCustomizationsVariables`)
+
+Use this entry point file to modify the original variables of the current loaded theme by adding the entry point after your own variable definitions in the theme.
+In the theme, it should be imported as shown below:
+
+```scss hl_lines="2"
+@import 'variables';
+@import 'addonsThemeCustomizationsVariables';
+@import 'typography';
+@import 'utils';
+@import 'layout';
+```
+
+Volto will not only load your add-on entry point files, but it will also detect all the add-ons that have these entry point files and import them grouped under a single file.
+It will also automatically add an `addonsThemeCustomizationsVariables` alias that can be referenced from the theme as shown above.
+
+### Main (`addonsThemeCustomizationsMain`)
+
+This entry point is intended to add your own style definitions, complementing those in the theme.
+You should add it after all the CSS of your theme:
+
+```scss hl_lines="6"
+@import 'blocks/search';
+@import 'blocks/listing';
+
+@import 'temp';
+
+@import 'addonsThemeCustomizationsMain';
+
+/* No CSS beyond this point */
+```
+
+Volto will also detect all the add-ons that have these entry point files, and import them grouped under a single file, and will automatically add an `addonsThemeCustomizationsMain` alias that can be referenced from the theme as shown above.
+
+```{note}
+It will only work in combination with the theme declaration in `volto.config.js` or in `package.json`.
+```

news/4625.feature

@@ -0,0 +1,2 @@
+Support for declaring a theme in `volto.config.js` or in `package.json`
+Add two entrypoints for allowing extending a theme from other add-ons. @sneridagh

razzle.config.js

@@ -8,6 +8,7 @@ const fs = require('fs');
 const RootResolverPlugin = require('./webpack-plugins/webpack-root-resolver');
 const RelativeResolverPlugin = require('./webpack-plugins/webpack-relative-resolver');
 const createAddonsLoader = require('./create-addons-loader');
+const createThemeAddonsLoader = require('./create-theme-addons-loader');
 const AddonConfigurationRegistry = require('./addon-registry');
 const CircularDependencyPlugin = require('circular-dependency-plugin');
 const TerserPlugin = require('terser-webpack-plugin');
@@ -245,6 +246,28 @@ const defaultModify = ({
     'lodash-es': path.dirname(require.resolve('lodash')),
   };
 
+  const [
+    addonsThemeLoaderVariablesPath,
+    addonsThemeLoaderMainPath,
+  ] = createThemeAddonsLoader(registry.getCustomThemeAddons());
+
+  // Automatic Theme Loading
+  if (registry.theme) {
+    // The themes should be located in `src/theme`
+    const themePath = registry.packages[registry.theme].modulePath;
+    const themeConfigPath = `${themePath}/theme/theme.config`;
+    config.resolve.alias['../../theme.config$'] = themeConfigPath;
+    config.resolve.alias['../../theme.config'] = themeConfigPath;
+
+    // We create an alias for each custom theme insertion point (variables, main)
+    config.resolve.alias[
+      'addonsThemeCustomizationsVariables'
+    ] = addonsThemeLoaderVariablesPath;
+    config.resolve.alias[
+      'addonsThemeCustomizationsMain'
+    ] = addonsThemeLoaderMainPath;
+  }
+
   config.performance = {
     maxAssetSize: 10000000,
     maxEntrypointSize: 10000000,

requirements-docs.txt

@@ -5,7 +5,8 @@ lesscpy
 linkify-it-py
 myst-parser
 sphinx-autobuild
-sphinx-book-theme
+pydata-sphinx-theme<=0.8.99
+sphinx-book-theme==0.3.3
 sphinx-copybutton
 sphinx-sitemap
 sphinx-togglebutton