Page Settings

At the top of every .mdx file, between --- delimiters, you can add settings that tell folio.md how to handle the page. folio.md validates every setting at build time and fails with a clear error if a value is wrong.

---
title: My Page
description: A short summary for search engines and social previews.
---

The title field is the only required setting. Everything else is optional.

Title

Your page’s name. It appears as the heading at the top of the page, in the browser tab as {title} | {site name}, in the sidebar, and in search engine results.

---
title: Getting Started
---

Description

A short summary of what the page covers. folio.md shows it in search engine snippets, social preview cards, and the site’s full-text search results. If you omit it, folio.md falls back to the site-level description from folio.config.ts.

---
title: Getting Started
description: Install folio.md and publish your first docs site.
---

Sidebar icon

An icon displayed next to the page’s entry in the sidebar. Works only for top-level pages and section headers defined in _section.mdx. Setting an icon on a page nested inside a section has no visible effect, and folio.md emits a build warning.

See the Icon Reference for all accepted names.

---
title: Getting Started
icon: Rocket
---

Show or hide the page heading

By default, folio.md adds a heading at the top of every page using the title value. Set showTitle: false to hide it. This is useful for landing pages where you want to write your own heading layout in the page body.

---
title: Home
showTitle: false
---

Author

The name of the person who wrote this page. It appears below the page heading alongside the reading time, separated by a ·. folio.md also includes it in the page’s metadata for search engines and in JSON-LD structured data.

---
title: Deep Dive into Caching
author: Alice
---

Keywords

A list of keywords for the page. folio.md adds them to the page’s metadata. Modern search engines don’t rely on this field heavily, but it can help internal tooling and site-search tuning.

---
title: Caching
keywords: [cache, CDN, performance]
---

Exclude from search engines

Prevents search engines from indexing this page and removes it from the sitemap and Atom feed. Use it for draft pages, internal content, or anything you don’t want appearing in external search results.

---
title: Draft: New Feature
noIndex: true
---

Redirect to another page

Redirects visitors from this page’s URL to another page. The redirect happens at the server level with no JavaScript involved. Use this when you rename or move a page so that old links still work.

folio.md excludes redirect stubs from the sidebar, search, and prev/next pagination.

---
title: Old Page Title
alias: /guide/new-page-title
---