文档上下文(context)是一个用于管理和显示不同类型文档的标记系统。通过在文档元数据中设置上下文标记,可以为文档添加诸 如根据上下文隐藏、显示特定的标识徽章(Badge)等效果。
感谢 Rspress 对该功能提供的特别支持。
在文档侧边栏的元数据文件(如 _meta.json)中,为文档项添加 context 属性:
或 frontmatter 中:
目前支持以下几种上下文标记:
react - 显示 "React" 徽章,用于标识 React 相关文档vue - 显示 "Vue" 徽章,用于标识 Vue 相关文档,这里的 Vue 仅用于举例被框架类型标记的文档,会被 DSL Switcher 组件自动在侧边栏中展示和隐藏。
同时,使用框架标记的文档,需要遵守以下命名规范,以在 DSL Switcher 切换的时候,获得自动重定向的效果。
访问直接操作节点查看实际效果。
custom-context - 显示 "custom-context" 徽章,用于标识内部文档new - 显示 "New" 徽章,用于标识新增文档