Developer Document

一个功能完善的开发者文档系统，用于展示组件库、API文档和开发指南。为开发团队提供统一的文档平台，提高开发效率和协作质量。

功能特点

• 📚 组件库展示：展示和记录组件库的使用方法和示例，支持代码预览和在线调试
• 🔍 API文档：提供详细的API接口文档，包括请求参数、响应格式和示例代码
• 👤 用户系统：支持用户注册、登录、权限管理和个性化设置
• 🛠️ 管理后台：提供组件管理、文档管理、用户管理和系统配置功能
• 📁 文件管理：支持文件上传、存储、版本控制和权限管理
• 📧 消息通知：支持邮件通知、站内消息和更新提醒功能

主要功能模块

组件库展示

• 组件分类：按功能、类型等多维度对组件进行分类展示
• 组件详情：展示组件的属性、事件、方法和使用示例
• 在线预览：支持组件的在线预览和交互式调试
• 代码示例：提供多种使用场景的代码示例
• 版本历史：展示组件的版本历史和更新日志

API文档管理

• 接口分组：支持按模块、功能等对API接口进行分组管理
• 接口详情：展示接口的URL、方法、参数、响应和状态码等信息
• 在线测试：支持在线发送API请求并查看响应结果
• 文档导出：支持将API文档导出为PDF、Markdown等格式
• 版本控制：支持API文档的版本控制和历史查看

用户和权限管理

• 用户认证：支持多种登录方式，包括账号密码、第三方登录等
• 权限控制：基于角色的权限控制系统，精细化管理用户权限
• 个人中心：用户可以管理个人信息、收藏内容和通知设置
• 操作日志：记录用户的关键操作，支持审计和追溯

管理后台

• 内容管理：管理组件、文档、博客等内容
• 用户管理：管理用户账号、角色和权限
• 系统配置：配置系统参数、主题和功能模块
• 数据统计：提供访问统计、使用情况分析等数据报表

环境变量配置

创建一个.env文件在server目录下：

DB_DIALECT=sqlite           # 数据库类型：sqlite, mysql, postgres
DB_HOST=data.db             # 数据库主机/文件路径
DB_USERNAME=                # 数据库用户名（如果使用mysql/postgres）
DB_PASSWORD=                # 数据库密码（如果使用mysql/postgres）
DB_DATABASE=                # 数据库名称（如果使用mysql/postgres）
ENV=local                   # 环境：local, staging, prod
PORT=8061                   # 服务器端口

许可证

MIT