Frontmatter contains the metadata for a page, such as the title. It is written as YAML, between ---, at the top of the page.
For example:
---
title: Create a Cloudflare Tunnel
pcx_content_type: how-to
products:
- cloudflare-tunnel
description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.
sidebar:
order: 2
---For more information on the available fields, refer to Nimbus's documentation ↗.
Every page with a pcx_content_type must include:
| Field | Description |
|---|---|
title |
The page title. Plain text. |
pcx_content_type |
The content type of the page. Refer to content types. |
description |
A 1-2 sentence summary used for the <meta name="description"> tag. Refer to writing a description. |
The description field populates the <meta name="description"> tag in the HTML head. This is the single most important metadata field for search engines, AI crawlers, and llms.txt consumers when deciding whether to surface or cite a page.
A strong description:
- Is 1-2 self-contained sentences (aim for 50-160 characters).
- Names the product or feature.
- States what the page helps the reader do or understand.
- Works as a standalone answer snippet when extracted from the page.
Do not start with generic openers like "This page describes...", "Learn more about...", or "This document explains...". These waste the most valuable metadata space without adding information.
The existing summary field remains useful for the on-page experience but is secondary to description for AI and search purposes.
description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.For optional fields such as sidebar, tags, products, difficulty, and reviewed, refer to Custom properties.
For more information on the available fields, refer to Nimbus's documentation ↗.