Page layouts
These are the page layouts that can be assigned to the
page_layoutkey in a page’s YAML front matter. For more general information, see Content Management.
Prerequisites
To use a page layout, you’ll need to add the page_layout key to your YAML front matter.
1
2
3
4
5
---
nav_title: Getting started
article_title: Getting started with Braze Docs
page_layout: PAGE_LAYOUT_VALUE
---
Replace PAGE_LAYOUT_VALUE with one of the values from the following sections.
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:
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:
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:
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:
In certain layouts, a value like "guide_top_text:" might benefit from having Markdown formatting. You can use Markdown formatting for certain YAML values. To do so, add > as the YAML value, and indent the text afterwards.
For example:
guide_top_text: >
# This is example Markdown formatting
Other layouts
Blank config
The blank_config value is used to hide a page on Braze Docs and automatically redirect users 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.
Edit this page on GitHub