#文档上下文与标签

#文档上下文（Context）

文档上下文（context）用于管理不同类型文档的侧边栏过滤。通过在文档元数据中设置上下文标记，可以根据上下文隐藏或显示侧边栏项。

在文档侧边栏的元数据文件（如 _meta.json）中，为文档项添加 context 属性：

{
  "context": "react"
}

或 frontmatter 中：

---
context: react
---

#框架类型标记

• react - 用于标识 React 相关文档
• vue - 用于标识 Vue 相关文档，这里的 Vue 仅用于举例

被框架类型标记的文档，会被 DSL Switcher 组件自动在侧边栏中展示和隐藏。

同时，使用框架标记的文档，需要遵守以下命名规范，以在 DSL Switcher 切换的时候，获得自动重定向的效果。

---
context: react
title: Foo
---

# Foo (ReactLynx)

---
context: vue
title: Foo
---

# Foo (Vue)

访问直接操作节点查看实际效果。

#侧边栏标签（Tag）

侧边栏标签（tag）用于在侧边栏中显示标识徽章（Badge），这是 Rspress 原生支持的功能。

在 frontmatter 中添加 tag 属性：

---
tag: BTS
---

或在 _meta.json 中：

{
  "tag": "BTS"
}

#内置标签

Rspress 内置了以下标签类型，会自动应用特定样式：

• new - 显示绿色 "New" 徽章
• experimental - 显示黄色 "Experimental" 徽章（带图标）
• deprecated - 显示红色 "Deprecated" 徽章（带图标）

#自定义标签

任何非内置的文本都会显示为默认样式的徽章，目前我们使用以下自定义标签：

• BTS - 标识仅在 BTS（Background Thread Script）中可用
• MTS - 标识仅在 MTS（Main Thread Script）中可用
• XElement - 标识 XElement 相关
• Android - 标识仅在 Android 平台可用
• iOS - 标识仅在 iOS 平台可用
• Web - 标识仅在 Web 平台可用
• Harmony - 标识仅在 Harmony 平台可用