文档上下文

文档上下文(context)是一个用于管理和显示不同类型文档的标记系统。通过在文档元数据中设置上下文标记,可以为文档添加诸如根据上下文隐藏、显示特定的标识徽章(Badge)等效果。

感谢 Rspress 对该功能提供的特别支持。

使用方法

在文档侧边栏的元数据文件(如 _meta.json)中,为文档项添加 context 属性

{
  "context": "custom-context"
}

frontmatter 中:

---
context: custom-context
---

内置上下文标记

目前支持以下几种上下文标记:

框架类型标记

  • react - 显示 "React" 徽章,用于标识 React 相关文档
  • vue - 显示 "Vue" 徽章,用于标识 Vue 相关文档,这里的 Vue 仅用于举例

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

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

foo.react.mdx
---
context: react
title: Foo
---

# Foo (ReactLynx)
foo.vue.mdx
---
context: vue
title: Foo
---

# Foo (Vue)

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

功能类型标记

  • custom-context - 显示 "custom-context" 徽章,用于标识内部文档
  • new - 显示 "New" 徽章,用于标识新增文档
除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。