Example Docs

Pages

Every documentation page is an MDX file with frontmatter metadata.

Frontmatter

---
title: My Page Title
description: A brief description of this page.
icon: rocket
order: 1
---

Available Properties

PropertyTypeDescription
titlestringPage title displayed in sidebar and heading
descriptionstringPage description for SEO and previews
iconstringIcon key from the icons registry
ordernumberSort order when using numeric ordering

Page Descriptions

Descriptions appear below the page title and in search results:

---
title: Authentication
description: Learn how to implement user authentication.
---

Icons

Reference icons from your docs.config.ts icons registry:

export default defineDocs({
  icons: {
    rocket: <Rocket size={16} />,
    shield: <Shield size={16} />,
  },
});

Then use them in frontmatter:

---
title: Security
icon: shield
---