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:

# Page Layout Configuration
name: "three-columns"
displayName: "Three columns"
description: "Three columns side-by-side 25/50/25"
entry: "markup.hbs"

# Content Zones
zones:
  lhs:
    displayName: "Left panel"
    description: "Left panel content area"

  main:
    displayName: "Main Content"
    description: "Main content area"

  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

An object 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.