这是 VoiceHub 智能点歌系统 的官方文档仓库。
VoiceHub 是一个现代化的智能点歌系统,支持多平台音乐搜索、智能排期管理,提供用户友好的界面设计。基于现代化技术栈构建,是一个稳定可靠的 Web 应用。
- 🎵 智能点歌: 支持多平台音乐搜索和点歌
- 👥 用户友好: 直观的界面设计,简单易用
- 🏗️ 现代化架构: 基于 Nuxt.js + Prisma + PostgreSQL
- Node.js 18.0 或更高版本
- pnpm
pnpm installpnpm docs:dev访问 http://localhost:8080 查看文档站点。
npm docs:build我们欢迎任何形式的贡献!
docs/
├── getting-started/ # 快速开始
├── user-guide/ # 用户指南
├── admin-guide/ # 管理员指南
├── development/ # 开发指南
└── troubleshooting/ # 故障排除
- 使用中文编写文档
- 遵循 Markdown 语法规范
- 添加适当的代码示例
- 保持文档结构清晰
- VuePress - 文档站点生成器(2.0.0-rc.18)
- Vue - 前端底层框架(3.x)
- Webpack - 模块打包/构建工具
- pnpm - 高效包管理工具
- vuepress-theme-hope - VuePress增强主题
- vuepress-plugin-search-pro - 文档高级搜索插件
- Sass - CSS预处理器(sass-embedded)
- MathJax - 专业数学公式渲染库
- Reveal.js - 交互式幻灯片(VuePress插件集成)
本项目基于 GPL-3.0 许可证 开源。