Frontmatter

Overview

Frontmatter is YAML metadata placed at the beginning of your markdown files. It controls how your page is displayed and indexed.

---
title: 'Page Title'
description: 'Brief description of the page content'
icon: 'icon-name'
---

Required Properties

title

The page title that appears in the sidebar navigation and as the main H1 heading on the page.

title: 'Getting Started'

description

Meta description used for SEO and displayed in search results. Also shown in the document overview.

description: 'Learn how to set up and configure your project'

Optional Properties

icon

Icon name from Lucide icons displayed next to the page title in the sidebar.

icon: 'rocket'        # Shows rocket icon
icon: 'book-open'     # Shows book-open icon
icon: 'settings'      # Shows settings icon

Example

Here's a complete frontmatter example:

---
title: 'API Reference'
description: 'Complete API documentation with examples and response schemas'
icon: 'code'
---

# Your markdown content starts here

This creates a page with:

• "API Reference" in the sidebar and as the H1

• SEO description for search engines

• Code icon in the sidebar