QXS-BNS 组件库文档指南

QXS-BNS 是一个基于 Vue 3 + TypeScript 构建的企业级组件库，专为趣学术业务场景设计。

📚 文档结构

🚀 快速开始

• 安装指南 - 安装和配置说明
• 快速开始 - 快速上手指南
• 特性介绍 - 组件库核心特性

📦 核心模块

• 组件库 - Vue 3 组件集合
• 工具函数 - 通用工具函数库
• Hooks - Vue 3 Composition API Hooks
• 指令 - Vue 自定义指令
• 图标 - SVG 图标库

🛠️ 开发指南

• 开发指南 - 开发环境搭建和规范
• 依赖管理 - 智能依赖管理系统
• 标签管理 - 版本标签管理工具

🚀 快速导航

👋 新手入门

1. 安装指南 - 环境要求和安装方式
2. 快速开始 - 5分钟上手指南
3. 特性介绍 - 组件库核心特性
4. 组件总览 - 浏览所有可用组件

💻 开发者

1. 开发指南 - 开发环境和规范
2. 依赖管理 - 智能依赖管理
3. 组件开发 - 组件开发约定

🔧 维护者

1. 项目架构 - 项目结构说明
2. 构建发布 - 构建和发布流程
3. 标签管理 - 版本标签管理

📖 使用指南

🎯 按场景选择

桌面端应用

• 使用完整组件库，包含 Element Plus 增强组件
• 适合管理后台、数据展示等场景

移动端应用

• 使用轻量级组件，不依赖 Element Plus
• 适合 H5 页面、移动端应用

工具函数

• 独立使用各种工具函数
• 支持按需引入，减少打包体积

📋 模块说明

模块	说明	适用场景
Components	Vue 3 组件	桌面端/移动端 UI
Utils	工具函数	通用业务逻辑
Hooks	Composition API	Vue 3 状态管理
Directives	自定义指令	DOM 操作增强
Icons	SVG 图标	图标展示

🌟 特色功能

• 🎯 企业级 - 专为企业级应用设计
• 📱 移动友好 - 支持桌面端和移动端
• 🔧 智能依赖 - 自动管理组件依赖关系
• 📦 按需加载 - 支持 Tree-shaking
• 🎨 主题定制 - 灵活的主题系统
• 📝 TypeScript - 完整的类型定义

📚 文档规范

• 所有文档使用 Markdown 格式
• 遵循统一的文档模板
• 包含完整的示例代码
• 提供清晰的 API 说明
• 支持在线演示和代码预览