ページツリー

ページツリーは、すべてのナビゲーションリンクと、区切りやフォルダーなどの項目を表すツリー構造です。

ページツリーはクライアントに送信され、サイドバーやパンくずリストなどのナビゲーション要素から参照されます。 そのため、機密データやサイズの大きいデータをページツリーに含めないでください。

規約アンカーリンクをコピー

ページツリーの型定義をインポートできます。ページツリーをハードコードしたり生成したりする場合に役立ちます。

import type * as PageTree from 'fumadocs-core/page-tree';

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

一部のノードには $ref プロパティが含まれていますが、これは内部用のものであり、ハードコードする場合には使用しません。

Rootアンカーリンクをコピー

ページツリーの初期ルートです。

Pageアンカーリンクをコピー

リンクを表すノードです。

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

フォルダーアンカーリンクをコピー

複数の子ノードを含むノードです。

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

セパレーターアンカーリンクをコピー

アイテムの間に表示するラベルです。

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

アイコンアンカーリンクをコピー

アイコンは ReactElement で、ページとフォルダーに設定できます。