Page Configuration
Reference for configuring page-level metadata using MDX front matter, including title, description, SEO properties, and structured data.
Front matter is a block of YAML configuration placed at the very top of an MDX file, enclosed by triple-dashed lines (---). It allows you to define metadata for each page individually.
---
title: "Introduction"
description: "Learn about the core concepts and get started with our platform."
---
---
title: "How to Integrate our API"
description: "A step-by-step guide to integrating our API into your application, with code samples."
ogImage: "https://example.com/images/api-integration-social.png"
canonical: "https://docs.example.com/api/integration"
jsonLd:
"@context": "https://schema.org"
"@type": "HowTo"
"step": [
{
"@type": "HowToStep",
"text": "Get your API keys from the dashboard."
},
{
"@type": "HowToStep",
"text": "Authenticate your requests."
}
]
---
Properties
The main title of the page. Used for the browser tab, navigation, search results, and social sharing cards.
A brief summary of the page content (120-160 characters). Used for SEO meta descriptions and social sharing cards.
Overrides the browser tab title, Open Graph title, Twitter card title, and JSON-LD headline without changing the visible page heading. Falls back to title when not set. Useful when you need a shorter or more search-optimized title for search engines and social previews while keeping a descriptive H1 for readers.
Overrides the SEO meta description, Open Graph description, and Twitter card description without changing the visible page subtitle or description text. Falls back to description when not set. Use this to craft a different search snippet than what appears on the page itself.
The URL for a custom Open Graph image (1200x630px recommended) to use for social sharing cards. Overrides the auto-generated image.
The canonical URL for the page to prevent duplicate content issues. Defaults to the page's own URL.
Adds JSON-LD structured data for rich search results, conforming to Schema.org vocabulary. The key can also be jsonld (lowercase).
You can also include any other custom key-value pairs in your front matter. This data is not used by default but can be accessed for custom component or theme logic.
Page layout options such as show-sidebar, show-toc, show-parent-label, content-width, and badge are configured in the navigation section of your site configuration, not in front matter.