Pages

Configure page metadata, titles, descriptions, icons, and layout modes using YAML frontmatter properties at the top of your MDX documentation.

Each page is a Markdown file. You can use either .mdx or .md file types for your pages. Use MDX, which combines Markdown with React components for rich, interactive documentation. Plain Markdown (.md) can expedite migration from other platforms, but switching to MDX enables more features.

Every page begins with frontmatter, the YAML metadata enclosed by --- at the top of a file. This metadata controls how your page appears and behaves.

All frontmatter fields are optional. If you omit title, Mintlify generates one from the file path. You can skip the frontmatter block entirely on pages that don't need custom metadata.

Use frontmatter to control:

• Page titles and descriptions
• Sidebar titles, icons, and tags
• Page layouts
• SEO meta tags
• Custom metadata

• title (string) — The title of your page that appears in navigation and browser tabs.

If omitted, Mintlify generates a title from the path. The last segment of the path becomes the title, with dashes and underscores replaced by spaces and the first letter capitalized. For example, guides/getting-started.md becomes Getting started.

• description (string) — A brief description of what this page covers. Displays under the title and improves SEO.

• sidebarTitle (string) — A short title that displays in the sidebar navigation.

• icon (string) — The icon to display.

Options:

• Font Awesome icon name
• Lucide icon name
• Tabler icon name
• A single emoji (for example, 💡 or 🚀)
• URL to an externally hosted icon
• Path to an icon file in your project

• iconType (string) — For Font Awesome icons only. The style of the icon.

Options: regular, solid, light, thin, sharp-solid, duotone, brands.

• tag (string) — A tag that appears next to your page title in the sidebar.

• hidden (boolean) — Set to true to remove the page from the sidebar navigation. Users can still access the page via its URL, but search engines do not index it. To make a page visible again, remove this field entirely. Do not set to false as it results in undefined behavior. See Hidden pages for details.

• noindex (boolean) — Set to true to exclude the page from site search, sitemaps, search engine indexing, and AI assistant context. The page remains visible in navigation. See Disable indexing for details. All pages with hidden: true in their frontmatter receive noindex: true automatically.

• searchable (boolean) — Defaults to true. Pages are searchable unless you opt out. Set to false to exclude the page from your documentation site's search results and the AI assistant context. The page stays indexable by external search engines, listed in your sitemap, and visible in navigation. See Exclude a page from search for details.

• boost (number) — Multiply the page's in-product search ranking by this factor. Use values greater than 1 to prioritize the page and values between 0 and 1 to de-prioritize it. See Search for details. boost has no effect when searchable: false, since the page doesn't appear in in-product search results.

• deprecated (boolean) — Set to true to display a "deprecated" label next to the page title. Use this to mark outdated content or legacy features while keeping the page accessible.

• hideFooterPagination (boolean) — Set to true to hide the previous/next page navigation links at the bottom of the page. Use this for standalone pages like landing pages or reference pages where sequential navigation does not apply.

• related (array or boolean) — A list of related pages to show in the Related topics section at the bottom of the page, or false to hide the section entirely. Overrides the project's automatic suggestions. Requires enabling the Related pages add-on.

• hideApiMarker (boolean) — Set to true to hide the HTTP method badge (such as GET or POST) next to the page title in the sidebar. Use this for API pages where you want a cleaner sidebar appearance.

• contextual (object) — Override the site-wide contextual menu for this page. Accepts the same options array and display value as the contextual field in docs.json. Omit the field to inherit the global configuration, or set options: [] to disable the contextual menu on this page.

• groups (string[]) — Restrict the page to users in specific groups. Users must belong to at least one listed group to access the page. You must configure authentication first. See Control access with groups for more information.

• <custom> (string) — Any valid YAML frontmatter. For example, product: "API" or version: "1.0.0".

---
title: "About frontmatter"
description: "Frontmatter is the metadata that controls how your page appears and behaves"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NEW"
---

Control your page's layout with the mode setting.

If you do not define a mode, the page uses a standard layout with sidebar navigation and table of contents.

---
title: "Default page title"
---

Wide mode hides the side panel, which includes the table of contents, <Panel> components, and API request and response examples. Use this mode for pages without headings or if you want extra horizontal space. Every theme supports wide mode.

---
title: "Wide page title"
mode: "wide"
---

Custom mode provides a minimalist layout and removes all elements except for the top navbar. This mode hides the sidebar, table of contents, and footer. Treat custom mode as a blank canvas to build landing pages or unique layouts with minimal navigation. All themes support custom mode.

---
title: "Custom page title"
mode: "custom"
---

Frame mode provides a layout similar to custom mode but keeps the sidebar navigation. Use this mode to include custom HTML and components while preserving the default navigation experience. Aspen, Almond, Luma, and Sequoia themes support frame mode.

---
title: "Frame page title"
mode: "frame"
---

Center mode removes the sidebar and table of contents, and centers the content. Use center mode for changelogs or other pages where you want to place focus on the content. Mint, Linden, Willow, and Maple themes support center mode.

---
title: "Center page title"
mode: "center"
---

Assistant mode renders the page as a full-screen assistant experience. A chat interface replaces all page content. Use this mode to create a dedicated page for users to interact with the assistant, such as an "Ask AI" page. Every theme supports assistant mode.

To use assistant mode, you must enable the assistant on your project. If you don't enable the assistant, the assistant page mode shows a disabled search field.

---
title: "Ask AI"
description: "Ask questions about how to get started and use the product"
mode: "assistant"
---

To create an interactive API playground, add an API specification to your frontmatter by setting api or openapi.

---
openapi: "GET /endpoint"
---

Learn more about building API documentation.

Link to external sites directly from your navigation with the url metadata.

---
title: "npm Package"
url: "https://www.npmjs.com/package/mint"
---

Mintlify automatically generates most SEO meta tags. You can set SEO meta tags manually to customize your approach to SEO, social sharing, and browser compatibility.

---
"twitter:image": "/images/social-preview.jpg"
---

See SEO for the full list of SEO metadata options.

Help users discover a specific page in search results by providing keywords in your metadata. These keywords don't appear in page content. If users search for the keywords, the page appears in the search results.

---
keywords: ['configuration', 'setup', 'getting started']
---

To display a "Last modified on [date]" timestamp on all pages, enable metadata.timestamp in your global settings. This timestamp uses the date of the last Git commit that modified the page's source file.

"metadata": {
  "timestamp": true
}

To override the global timestamp setting for an individual page, use the timestamp frontmatter field. Use this field to show or hide timestamps on specific pages.

---
title: "Page title"
timestamp: false
---

If you set timestamp: true, the page always shows the timestamp even if the global setting is false. If you set timestamp: false, the page hides the timestamp even if the global setting is true.

To display a specific date instead of the Git commit date for an individual page, use the lastUpdatedDate frontmatter field. Use this field when your Git history doesn't reflect when the content changed, such as content imported or synced from another system. Use a date-only value or an ISO 8601 timestamp.

---
title: "Page title"
lastUpdatedDate: "2026-08-13"
---

Mintlify determines the displayed date in the following order:

1. The lastUpdatedDate frontmatter field, if set on the page.
2. For projects backed by Git, the date of the last commit that modified the page's source file.
3. The most recent deployment timestamp.

• Collect page feedback from users and AI agents
• Hidden pages
• Create and edit pages