Page layouts
These are the page layouts that can be assigned to the
page_layoutkey in a page’s YAML front matter. Mostpage_layoutkeys 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 layout is used to apply the API page format. In the following example, this format is applied to the List integrations page.
1
2
3
---
layout: api_page
---
dev_guide
The dev_guide layout is used to apply the developer guide format. In the following example, this format is applied to the Catalogs Endpoints page.
1
2
3
---
layout: dev_guide
---
featured
The featured layout is used to apply the featured page format. In the following example, this format is applied to the Predictive Events page.
1
2
3
---
layout: featured
---
glossary_page
The glossary_page layout is used to apply the glossary page format. In the following example, this format is applied to the Types of push notifications page.
1
2
3
---
layout: glossary_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
Use the blank_config layout with config_only: true to prevent a page’s content from displaying when its selected from the left-side navigation. This is helpful when you don’t plan on adding content to a subsection’s landing page.
1
2
3
4
---
layout: blank_config
config_only: true
---
redirect
The redirect layout is used to redirect an existing page from its current URL to a different URL of your choice.
Do not use this method if you also plan on moving the file, renaming the file, or renaming any of its parent directories. Instead, create a redirect in the broken_redirect_list.js file.
1
2
3
4
---
layout: redirect
redirect_to: NEW_URL
---
Replace NEW_URL with the URL you want to redirect to with https://www.braze.com/ removed from the URL string.
In the following example, _docs/_contributing/content_management/images.md is set to automatically redirect to https://www.braze.com/docs/contributing/home.
1
2
3
4
5
6
7
nav_title: Images
article_title: Managing Images
description: "Learn how to add, modify, and remove images on Braze Docs."
page_order: 1
layout: redirect
redirect_to: /docs/contributing/home
Edit this page on GitHub