跳转到内容
搜索文档

侧边栏

最后更新 查看 MarkdownAgent 设置

标签(Labels)

标签由给定页面上的 frontmatter 属性控制,根据您是配置分组(group)还是链接(link)而有所不同。

链接

优先级顺序如下:

  1. sidebar.label
  2. title

在索引页上

如果未定义 sidebar.label,索引页标签默认为 Overview(概览)。

由于 title 被用于分组标记,因此不会考虑 title

分组

优先级顺序如下:

  1. sidebar.group.label
  2. title

示例

例如,给定以下页面:

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

侧边栏结构将如下所示:

  • GroupTitle
    • IndexTitle
    • PageTitle

如果我们从两者中移除 sidebar 属性,它现在将看起来像这样:

  • Bar
    • Overview
    • Baz

排序

链接和分组均使用 sidebar.order frontmatter 属性来配置其顺序,其中分组根据索引页的顺序进行排序。

如果未指定 sidebar.order,它将回退到按字母顺序排序。

例如,给定以下页面:

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

侧边栏结构将如下所示:

  • Beta
    • ...
  • Alpha
    • ...

如果我们从两者中移除 sidebar 属性,它现在将看起来像这样:

  • Alpha
    • ...
  • Beta
    • ...

隐藏页面

有三个属性可用于从侧边栏中隐藏页面。

隐藏单个页面

hidden

此属性仅应在页面不是分组的索引页时使用。

---
title: Placeholder
sidebar:
  hidden: true
---

group.hideIndex

由于依赖索引页来配置分组的标签和排序顺序,我们有一个特殊属性,它仍然使该页面对我们的侧边栏组件可用,并允许我们在对分组进行标记和排序后将其移除。

---
title: Placeholder
sidebar:
  group:
    hideIndex: true
---

import { DirectoryListing } from "~/components";

<DirectoryListing />

隐藏分组的子页面

要使分组渲染为指向索引页的单个页面,请使用顶层的 hideChildren 属性。

徽章

链接

要在链接旁指定一个徽章,请使用 sidebar.badge 属性。

/src/content/docs/examples/example.mdxmdx
---
title: Example
sidebar:
  badge: New!
---
  • Examples
    • Example [New!]

分组

要在分组标签旁指定一个徽章,请在分组的 index.mdx frontmatter 中使用 sidebar.group.badge

/src/content/docs/examples/index.mdxmdx
---
title: Examples
sidebar:
  group:
    badge: New!
---
  • Examples [New!]
    • Example

自动“Beta”徽章

“Beta” 徽章会自动添加到其 URL 匹配具有 “Beta” 可用性状态的目录项的侧边栏链接和分组中。 此徽章不受 frontmatter 控制——它衍生自与 src/content/directory/ 中条目关联的产品可用性数据。

这篇文档对您有帮助吗?