Frontmatter

Every Markdown file referenced in the TOC may optionally define a frontmatter block. Frontmatter is YAML-formatted metadata about a page, at the beginning of each file and wrapped by --- lines.

In the frontmatter block, you can define the following fields:

---
navigation_title: This is the navigation title.
meta_title: This is the page title for search results and browser tabs.
description: This is a description of the page.
applies_to:
  serverless: all
products:
  - id: apm-agent
  - id: edot-sdk
sub:
  key: value
cta:
  id: beta
---
		

Unknown frontmatter keys are ignored and reported as hints, not errors. The message names the key, its line, and the closest valid key when there is one, for example Unknown key 'navigaton_title'. Did you mean 'navigation_title'?.

1. navigation_title
2. meta_title
3. description
4. applies_to
5. products
6. sub
7. cta

See Page title

Use meta_title when the page title in browser tabs and search results needs different wording than the heading. By default, the page title comes from the level-one heading. The builder appends the site name, so don't include it in meta_title.

---
meta_title: Search across clusters
---

# Cross-cluster search
		

Use the description frontmatter to set the description meta tag for a page. This helps search engines and social media. It also sets the og:description and twitter:description meta tags.

The description frontmatter is a string, recommended to be around 150 characters. If you don't set a description, it will be generated from the first few paragraphs of the page until it reaches 150 characters.

See Applies to

The products frontmatter is a list of products that the page relates to. This is used for the "Products" filter in the Search UI.

The products frontmatter is a list of objects, each object has an id field. Only products with the public-reference feature enabled in products.yml are valid here. Products that have set public-reference: false cannot be used in frontmatter.

Use the sub field to define local substitutions. Refer to Substitutions for more information.

See CTA.