Project Configuration

The project configuration file is located in /.helix/config.xlsx (for sharepoint) or /.helix/config (for google drive). It consists of a table using Key and value columns. For example:

The format of the keys follows the identifier-dot notation, like in javascript. You can think of the sheets as a flattened JSON structure. If a key appears more than once, it would form an array, eg:

Will conceptually be a structure like:

{
  "access": {
    "allow": [
      "*@adobe.com",
      "*@example.com",
    ]
  }
}

The following table lists the configuration options of a project.

Also see the JSON Schema and Typescript Types of this config.

Blueprints

A project can define configuration blueprints that serve as defaults for the config.

The blueprints are defined in the .helix directory of the github repository. eg:

adobe/franklin-defaults
  ├── README.md
  ├── .helix/
  │   ├── blueprint-targets.json
  │   └── blueprint-config.json
  └── fstab.yaml

• The .helix/blueprint-config.json contains the blueprint configuration
• The .helix/blueprint-targets.json contains the list of allowed projects that can use the blueprint

The blueprint-targets.json needs to be a JSON array with the owner/repo names, eg:

[
	"adobe/franklin-project1",
	"adobe/franklin-project2"
]

Each project wanting to use the blueprint will need to register the blueprint configuration repository using the blueprint property in .helix/config.json (see configuration options above) and be listed in the .helix/blueprint-targets.json in the blueprint configuration repository.

This two-way referencing is needed to ensure that no project can steal the configuration of another one,
And that no blueprint repository can force their config on an unrelated project.

Note: The blueprints configuration are only applied when the respective configuration files (/.helix/config, /.helix/headers, /metadata) are previewed, but not when the blueprint config is pushed.

The blueprints contain the defaults for the project config (as described above). They can also provide defaults for the headers and metadata configuration and have the following structure:

{
  "config": {
    "data": {
      ....project config
    }
  },
  "metadata": {
    "data": {
      ....metadata config
    }
  },
  "headers": {
    "data": {
      ....headers config
    }
  }
}

The metadata and the headers config follow the Modifiers format, which are an array of key/value pairs within path glob objects. Eg:

"metadata": {
    "data": {
      "/news/**": [
        {"key": "category", "value": "news"},
        {"key": "locale", "value": "en-US"}
      ],
      "/blog/**": [
        {"key": "category", "value": "blog"}
      ],
      "/**": [
        {"key": "title", "value": "ACME CORP"},
        {"key": "description", "value": "Lorem ipsum dolor…"},
        {"key": "locale", "value": "en-US"}
      ]
    },
  },
}