コンテンツにスキップ

サイドバー

ラベル

ラベルは、特定のページのフロントマターのプロパティによって制御され、グループまたはリンクを設定するかどうかによって異なります。

リンク

優先順位の順に:

  1. sidebar.label
  2. title

インデックスページの場合

インデックスページのラベルは、sidebar.labelが定義されていない場合、デフォルトでOverviewになります。

titleはグループラベリングに使用されるため、考慮されません。

グループ

優先順位の順に:

  1. sidebar.group.label
  2. title

例

例えば、次のページがあるとします:

src/content/docs/foo/bar/index.mdx
---
title: Bar
sidebar:
  label: IndexTitle
  group:
    label: GroupTitle
---
src/content/docs/foo/bar/baz.mdx
---
title: Baz
sidebar:
  label: PageTitle
---

サイドバーの構造は次のようになります:

  • ディレクトリGroupTitle
    • IndexTitle
    • PageTitle

両方からsidebarプロパティを削除すると、次のようになります:

  • ディレクトリBar
    • Overview
    • Baz

順序

リンクとグループの両方は、sidebar.orderフロントマターのプロパティを使用して順序を設定します。グループはインデックスページの順序に基づいて順序付けられます。

sidebar.orderが指定されていない場合、アルファベット順にフォールバックします。

例えば、次のページがあるとします:

src/content/docs/foo/alpha/index.mdx
---
title: Alpha
sidebar:
  order: 3
---
src/content/docs/foo/beta/index.mdx
---
title: Beta
sidebar:
  order: 2
---

サイドバーの構造は次のようになります:

  • ディレクトリBeta
    • …
  • ディレクトリAlpha
    • …

両方からsidebarプロパティを削除すると、次のようになります:

  • ディレクトリAlpha
    • …
  • ディレクトリBeta
    • …

ページの非表示

サイドバーからページを非表示にするために使用できるプロパティは3つあります。

個別ページの非表示

hidden

このプロパティは、ページがグループのインデックスページでない場合にのみ使用する必要があります。

---
title: プレースホルダー
sidebar:
  hidden: true
---

group.hideIndex

インデックスページはグループのラベルとソート順を設定するために依存しているため、ページをサイドバーコンポーネントに利用可能にし、グループのラベリングと順序付けの後に削除できる特別なプロパティがあります。

---
title: プレースホルダー
sidebar:
  group:
    hideIndex: true
---


import { DirectoryListing } from "~/components";


<DirectoryListing />

グループの子ページの非表示

グループをインデックスページにリンクする単一のページのようにレンダリングさせるには、トップレベルのhideChildrenプロパティを使用します。

Cloudflare DashboardDiscordCommunityLearning CenterSupport Portal
Cookie Settings