Layout configuration file

The layout configuration file defines the metadata and content zones for your layout.

Configuration file example

The following example shows a three-column layout configuration:

{
    "name": "three-columns",
    "displayName": "Three columns",
    "description": "Three columns side-by-side 25/50/25 layout",
    "entry": "markup.hbs",
    "zones": [
        {
            "key": "lhs",
            "displayName": "Left panel",
            "description": "Left panel content area"
        },
        {
            "key": "main",
            "displayName": "Main panel",
            "description": "Primary content area"
        }
        {
            "key": "rhs",
            "displayName": "Right panel",
            "description": "Right panel content area"
        }
    ]
}

Configuration file structure

The configuration file contains:

name

The internal identifier for the layout. This must be unique within your DXP instance.

displayName

The name displayed to editors in the Page Builder.

description

A description of the layout’s purpose.

entry

The filename of the template file (typically markup.hbs).

zones

A JSON array defining the content zones available in the layout. Each zone has:

A zone identifier

For example, lhs, main, rhs.

displayName

The name displayed to editors for this zone.

description

A description of what content should go in this zone.