To nest a site at a sub-path of another site, create a configuration file such as: /🔌path-name.yaml where "path-name" will become the directory where the site is nested at. For example, if your main site is hosted at https://abccompany.com/, a configured nested site /🔌store.yaml would host the nested site at https://abccompany.com/store/

source

The only required field for a site mount is the location to obtain the nested site's source code.

source: https://github.com/owner/project.git

To specify a branch:

source: https://github.com/owner/project.git#branch

To specify a tag (prefix with '!'):

source: https://github.com/owner/project.git#!tag

The owner must match the owner of the source including this nested mount.

namespace

If the nested site is data driven, then it must be assigned a data namespace. This ensures the data remains relevant if you later change its path. Minimum length is 4 characters, maximum length is 25 characters.

namespace: my-namespace

Shared Data

A nested site may share data with its parent by specifying:

namespace: shared

However this should only be used in special scenarios, especially when the parent and nested site are sharing the same data model.

Changing the namespace identifier after it contains live / production data will result in a loss of data.

🎨

If the nested site contains a properties file, then the values in this file may be overridden, where the values beneath "🎨" correspond to values in the nested site's 🎨.scss file.

🎨:
  some-option: true
  the-color: aliceblue

keys

Since secure keys and credentials are scoped to the parent, there may be certain keys that the parent needs to expose to a nested site. The parent must explicitly specify individual keys, and any other keys will be non-existent for the nested site.

keys:
  - api:stripe.com