useCategory

GitHub 查看源码

useCategory 管理文档侧边栏的分类配置系统，通过 categories 属性定义各分类的显示标题和排序规则，将组件或 Composable 文档按功能分组展示。在 app/composables/useCategory.ts 中覆盖实现即可自定义分类配置。

概述

管理文档的分类系统，方便对文档进行分组和导航。

配置分类

在项目中创建 composables/useCategory.ts 覆盖默认配置：

export function useCategory() {
  return {
    categories: {
      components: [
        {
          id: 'content',
          title: 'Content Components',
          icon: 'i-lucide-component'
        },
        {
          id: 'layout',
          title: 'Layout Components',
          icon: 'i-lucide-layout-dashboard'
        }
      ],
      composables: [
        {
          id: 'navigation',
          title: 'Navigation',
          icon: 'i-lucide-compass'
        },
        {
          id: 'ui',
          title: 'UI Utilities',
          icon: 'i-lucide-sparkles'
        }
      ]
    }
  }
}

Frontmatter 中使用分类

---
title: ComponentPropsLinks
category: content
---

API

`useCategory()`

返回分类配置。

返回值

Changelog

No recent changes

useNavigation

useNavigation 管理文档侧边栏导航树结构，提供按分类分组的子导航列表、根级导航项集合和面包屑导航数据。基于 Nuxt Content 的 queryCollectionNavigation API 构建，配合 useCategory 使用实现侧边栏分组导航。

useTheme

useTheme 是主题定制系统的核心 Composable，管理 Primary 主色调、Neutral 中性色、圆角大小、字体系列和图标集配置，支持深色/浅色/系统三种颜色模式。可从 ThemePicker 导出 CSS 变量或 app.config.ts 配置持久化主题。