Page layouts

These are the page layouts that can be assigned to the page_layout key in a page’s YAML front matter. Most page_layout keys will visually modify the page—however, some only modify how the page functions. For more general information, see About content management.

Applying a layout

To apply a layout to your page, add the following line to your YAML front matter, then replace PAGE_LAYOUT_VALUE with one of the keys found on this page.

1
2
3
---
page_layout: PAGE_LAYOUT_VALUE
---

Visual layouts

API page

The api_page value is used to apply the API page format. In the following example, this format is applied to the List integrations page:

• example output

Developer guide

The dev_guide value is used to apply the developer guide format. In the following example, this format is applied to the Catalogs Endpoints page:

• example output

Featured page

The featured value is used to apply the featured page format. In the following example, this format is applied to the Predictive Events page:

• example output

Glossary page

The glossary_page value is used to apply the glossary page format. In the following example, this format is applied to the Types of push notifications page:

• example output

Other layouts

Blank config

The blank_config value is combined with config_only: true to make the current article a folder. This lets you create subsections without needing a landing page. Because the landing page becomes a folder and has no page content, users who try to visit the URL directly are automatically redirected to www.braze.com/docs. For more information, see Redirecting URLs.

Redirect

The redirect value is used to redirect the URL for an in-page heading. For more information, see Redirecting URLs.