标签由给定页面上的 frontmatter 属性控制,根据您是配置分组(group)还是链接(link)而有所不同。
优先级顺序如下:
sidebar.labeltitle
如果未定义 sidebar.label,索引页标签默认为 Overview(概览)。
由于 title 被用于分组标记,因此不会考虑 title。
优先级顺序如下:
sidebar.group.labeltitle
例如,给定以下页面:
---
title: Bar
sidebar:
label: IndexTitle
group:
label: GroupTitle
------
title: Baz
sidebar:
label: PageTitle
---侧边栏结构将如下所示:
- GroupTitle
- IndexTitle
- PageTitle
如果我们从两者中移除 sidebar 属性,它现在将看起来像这样:
- Bar
- Overview
- Baz
链接和分组均使用 sidebar.order frontmatter 属性来配置其顺序,其中分组根据索引页的顺序进行排序。
如果未指定 sidebar.order,它将回退到按字母顺序排序。
例如,给定以下页面:
---
title: Alpha
sidebar:
order: 3
------
title: Beta
sidebar:
order: 2
---侧边栏结构将如下所示:
- Beta
- ...
- Alpha
- ...
如果我们从两者中移除 sidebar 属性,它现在将看起来像这样:
- Alpha
- ...
- Beta
- ...
有三个属性可用于从侧边栏中隐藏页面。
此属性仅应在页面不是分组的索引页时使用。
---
title: Placeholder
sidebar:
hidden: true
---由于依赖索引页来配置分组的标签和排序顺序,我们有一个特殊属性,它仍然使该页面对我们的侧边栏组件可用,并允许我们在对分组进行标记和排序后将其移除。
---
title: Placeholder
sidebar:
group:
hideIndex: true
---
import { DirectoryListing } from "~/components";
<DirectoryListing />要使分组渲染为指向索引页的单个页面,请使用顶层的 hideChildren 属性。
要在链接旁指定一个徽章,请使用 sidebar.badge 属性。
---
title: Example
sidebar:
badge: New!
---- Examples
- Example [New!]
要在分组标签旁指定一个徽章,请在分组的 index.mdx frontmatter 中使用 sidebar.group.badge。
---
title: Examples
sidebar:
group:
badge: New!
---- Examples [New!]
- Example
“Beta” 徽章会自动添加到其 URL 匹配具有 “Beta” 可用性状态的目录项的侧边栏链接和分组中。
此徽章不受 frontmatter 控制——它衍生自与 src/content/directory/ 中条目关联的产品可用性数据。