Skip to content

Metadata

These are the metadata keys that can be added to a page’s YAML front matter. For more general information, see Content Management.

To add metadata to a Markdown file, you’ll need to add Jekyll’s front matter syntax to the beginning of your file.

1
2
3
4
5
6
7

---
METADATA_KEY: METADATA_VALUE
---

# Getting started with Braze Docs

If you're new to Braze Docs or docs-as-code, start with our tutorial.

Replace the following:

Placeholder Description
METADATA_KEY The key representing a supported metadata type. Replace with a metadata key from the following section.
METADATA_VALUE The value assigned to the metadata key. Check a metadata key’s supported values in the following section.

Required keys

Article title

The article_title key is used to set the page title for online search results and the end-user’s browser tab. This key accepts any string value. For naming conventions, see the Braze Docs Style Guide.

1
2
3

---
article_title: Getting started with Braze Docs
---

Description

The description key is used to set the page description in online search results. This key accepts any string value under 150 characters that’s surrounded by double quotes.

1
2
3

---
description: "If you're new to Braze Docs, start with this step-by-step tutorial."
---

The nav_title key is used to set the page title on the left-side navigation bar on Braze Docs. This key accepts any string less than 30 characters. If the hidden key is set to true, nav_title is not required.

1
2
3

---
nav_title: Getting started
---

Optional keys

Engagement tool

The tool key is used to set the page’s related engagement tools. This key accepts one or more of the following string values as a list.

  • dashboard
  • docs
  • canvas
  • campaigns
  • currents
  • location
  • media
  • reports
  • segments
  • templates
1
2
3
4
5

---
tool:
  - currents
  - segments
---

Hide page from navigation

The hidden key is used to hide a page from the left-side navigation on Braze Docs. This key accepts the boolean values true or false.

1
2
3

---
hidden: true
---

Hide page from search

The noindex key is used to hide a page from internal and external search results (such as Braze Docs and Google Search). This key accepts the boolean values true or false.

1
2
3

---
noindex: true
---

Hide table of contents

The hide_toc key is used to hide the in-page table of contents (TOC) on the right side of the page. This key accepts the boolean values true or false.

1
2
3

---
hide_toc: true
---

Hide heading from table of contents

The toc_headers key is used to hide all headings of the same level from the in-page table of contents (TOC) on the right side of the page. This key accepts the following string values.

  • h1
  • h2
  • h3
  • h4

toc_headers will hide all headings matching its assigned value; it cannot be used to hide specific headings from the TOC.

1
2
3

---
toc_headers: h2
---

Messaging channel

The channel key is used to set a page’s related messaging channels. This key accepts one or more of the following string values as a list.

  • content cards
  • email
  • in-app messages
  • news feed
  • push
  • sms
  • webhooks
1
2
3
4
5

---
channel:
  - email
  - news feed
---

The config_only key is used to hide a page’s content without hiding it on left-side navigation bar. Use this key when creating a section without a landing page. This key accepts the boolean values true or false.

1
2
3

---
config_only: true
---

Override default URL

The permalink key is used with the hidden key to override the default URL for a page on Braze Docs. The value assigned to permalink will be prepended with https://www.braze.com/docs before redirecting. This key accepts any string value meeting the following requirements.

  • Characters are lowercase
  • Words are separated by underscores (_)
  • “Directories” are separated by forward slashes (/)
  • All other special characters are removed
1
2
3
4

---
hidden: true
permalink: /support_contact/docs_team/
---

Page layout

The layout key is used to set the layout for a page. If layout is not set, the default layout will be used. This key accepts any of the following string values.

  • api_page
  • dev_guide
  • featured_video
  • featured
  • glossary_page
  • blank_config
  • redirect

For more information about each value, see Page layouts.

1
2
3

---
page_layout: glossary_page
---

Page order

The page_order key is used to order sections on the left-side navigation bar. This key accepts any non-negative number (such as 0, 20, or 5.5).

1
2
3

---
page_order: 35.6
---

Page type

The page_type key is used to set formatting of a page. This key accepts any of the following string values.

  • glossary
  • solution
  • reference
  • tutorial
  • landing
  • partner
  • update

For more information about each value, see Page types.

1
2
3

---
page_type: tutorial
---

Platform

The platform key is used to set the page’s related platforms. This key accepts one or more Braze SDKs as a string value in a list.

1
2
3
4
5
6

---
platform:
  - iOS
  - Web
  - Android
---
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!