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
description: This is a description of the page
applies_to:
  serverless: all
products:
  - id: apm-agent
  - id: edot-sdk
---

1. navigation_title
2. description
3. applies_to
4. products

See Page title

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.