Fumadocs · Schema

Fumadocs Page

The frontmatter schema for a Fumadocs documentation page defined in an MDX or Markdown file. Page frontmatter provides the display title, description, icon, and optional layout flags used when rendering the page and generating the navigation tree. An extended _openapi field is attached by the fumadocs-openapi package to store OpenAPI-specific page metadata for API reference pages.

DocumentationFrameworkNext.jsReact

Properties

Name	Type	Description
title	string	The display title of the documentation page. Used as the page heading, browser tab title, and sidebar navigation label.
description	string	A short summary of the page content. Used in search result snippets, meta description tags, and navigation tooltips.
icon	string	Icon identifier or inline SVG content displayed alongside the page title in sidebar navigation and breadcrumbs. Supports Lucide icon names when using fumadocs-ui.
full	boolean	When true, the page uses the full-width layout without a table of contents sidebar, giving the content maximum horizontal space.
_openapi	object	OpenAPI-specific metadata attached to API reference pages generated by fumadocs-openapi. Contains operation details, schema references, and playground configuration used to render the interactive API

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://fumadocs.dev/schemas/page.json",
  "title": "Fumadocs Page",
  "description": "The frontmatter schema for a Fumadocs documentation page defined in an MDX or Markdown file. Page frontmatter provides the display title, description, icon, and optional layout flags used when rendering the page and generating the navigation tree. An extended _openapi field is attached by the fumadocs-openapi package to store OpenAPI-specific page metadata for API reference pages.",
  "type": "object",
  "required": ["title"],
  "properties": {
    "title": {
      "type": "string",
      "description": "The display title of the documentation page. Used as the page heading, browser tab title, and sidebar navigation label.",
      "minLength": 1,
      "example": "Getting Started"
    },
    "description": {
      "type": "string",
      "description": "A short summary of the page content. Used in search result snippets, meta description tags, and navigation tooltips.",
      "example": "Learn how to install and configure Fumadocs in your Next.js project."
    },
    "icon": {
      "type": "string",
      "description": "Icon identifier or inline SVG content displayed alongside the page title in sidebar navigation and breadcrumbs. Supports Lucide icon names when using fumadocs-ui."
    },
    "full": {
      "type": "boolean",
      "description": "When true, the page uses the full-width layout without a table of contents sidebar, giving the content maximum horizontal space."
    },
    "_openapi": {
      "type": "object",
      "description": "OpenAPI-specific metadata attached to API reference pages generated by fumadocs-openapi. Contains operation details, schema references, and playground configuration used to render the interactive API reference.",
      "additionalProperties": true
    }
  }
}