页面树

页面树是一种树状结构，用于描述所有导航链接，以及其他项目如分隔符和文件夹。

它将被发送到客户端，并在导航元素中被引用，包括侧边栏和面包屑导航。因此，您不应在页面树中存储任何敏感或大型数据。

注意

根据设计，页面树仅包含所有页面和文件夹的必要信息。

不可序列化的数据如函数无法传递到页面树。

约定

页面树的类型定义，供想要硬编码/生成它的人使用。您也可以从 Fumadocs 导入类型。

import type { PageTree } from 'fumadocs-core/server';

const tree: PageTree.Root = {
  // props
};

某些节点包含 $ref 属性，它们是内部属性，在硬编码时不使用。

页面树初始根节点。

Prop

Type

{
  "type": "page",
  "name": "Quick Start",
  "url": "/docs"
}

也支持外部 URL

Prop

Type

{
    "type": "folder",
    "name": "Guide",
    "index": {
        "type": "page",
        ...
    }
    "children": [
        ...
    ]
}

Prop

Type

项目之间的标签。

{
  "type": "separator",
  "name": "Components"
}

Prop

Type

图标是一个 ReactElement，由页面和文件夹支持。