Page Slugs & Page Tree

Overview

Fumadocs generates page slugs and page tree (sidebar items) from your content directory using loader(), the routing functionality will be handled by your React framework.

You can define folders and pages similar to file-system based routing.

File

For MDX & Markdown file, you can customise page information from frontmatter.

---
title: My Page
description: Best document ever
icon: HomeIcon
---

## Learn More

Fumadocs detects from the following properties to construct page trees.

Slugs

The slugs of a page are generated from its file path.

Folder

Organize multiple pages, you can create a Meta file to customise folders.

Folder Group

By default, putting a file into folder will change its slugs. You can wrap the folder name in parentheses to avoid impacting the slugs of child files.

Root Folder

Marks the folder as a root folder, only items in the opened root folder will be visible.

{
  "title": "Name of Folder",
  "description": "The description of root folder (optional)",
  "root": true
}

For example, when you are opening root folder framework, the other folders (e.g. headless) are not shown on the sidebar and other navigation elements.

Meta

Customise folders by creating a meta.json file in the folder.

{
  "title": "Display Name",
  "icon": "MyIcon",
  "pages": ["index", "getting-started"],
  "defaultOpen": true
}

Pages

Folder items are sorted alphabetically by default, you can add or control the order of items using pages.

{
  "pages": ["index", "getting-started"]
}

• Path: a path to page or folder, like./nested/page.
• Separator (---Label---): a separator between two sections, use ---[Icon]Label--- to include icons.
• Link ([Text](url)): insert links, use [Icon][Text](url) to include icons.

Special Items:

• Rest (...): include remaining pages (sorted alphabetically).
• Reversed Rest (z...a): reversed Rest item.
• Extract (...folder): extract the items from a folder.
• Except (!item): Exclude an item from ... or z...a.

{
  "pages": [
    "components",
    "---My Separator---",
    "...folder",
    "...",
    "!file",
    "!otherFolder",
    "[Vercel](https://vercel.com)",
    "[Triangle][Vercel](https://vercel.com)"
  ]
}

Icons

Since Fumadocs doesn't include an icon library, you have to convert the icon names to JSX elements in runtime, and render it as a component.

You can add an icon handler to loader().

i18n Routing

You can define different style for i18n routing.

import type { I18nConfig } from 'fumadocs-core/i18n';

export const i18n: I18nConfig = {
  // default
  parser: 'dot',
  // or
  parser: 'dir',
};