Skip to content

# DPS Plugins 文档系统 ​

这是一个基于 VitePress 的组件库文档系统，支持自动生成 API 文档和组件预览。

## 功能特性 ​

- 📚 自动生成组件 API 文档
- 🎨 组件在线预览
- 🔍 代码示例和复制功能
- 📱 响应式设计
- 🚀 快速搜索

## 使用方法 ​

### 启动开发服务器 ​

bash

    npm run docs:dev

访问 http://localhost:5173 查看文档（开发模式）。

### 构建文档 ​

bash

    npm run docs:build

### 预览构建结果 ​

bash

    npm run docs:preview

### 重新生成 API 文档 ​

bash

    npm run docs:generate

## 文档结构 ​

    docs/
    ├── .vitepress/
    │   ├── config.js          # VitePress 配置
    │   └── components/        # 文档组件
    ├── components/            # 组件文档
    ├── functions/            # 函数文档
    └── index.md             # 首页

## 添加新组件文档 ​

1. 在 `src/plugins/` 下创建新组件
2. 运行 `npm run docs:generate` 自动生成基础文档
3. 在 `docs/components/` 下编辑生成的文档，添加示例和说明

## 自定义文档组件 ​

可以在 `docs/.vitepress/components/` 下添加自定义组件，用于文档展示。

## 配置说明 ​

主要配置文件：`docs/.vitepress/config.js`

- 导航菜单配置
- 侧边栏配置
- 主题配置
- Vite 配置

## 贡献指南 ​

1. Fork 项目
2. 创建功能分支
3. 提交更改
4. 推送到分支
5. 创建 Pull Request

## 许可证 ​

MIT License