HaloLight Docs
English | 简体中文
HaloLight 多框架管理后台项目文档站点，基于 VitePress 构建，支持中英文双语。
项目关系
halolight/docs：文档与规范的唯一来源，定义跨框架的设计、接口和最佳实践halolight/halolight：Next.js 14 参考实现，验证规范的 React 路径halolight/halolight-vue：Vue 3.5 参考实现，验证规范的 Vue 路径
规范更新优先在本仓库落地，再同步到对应实现仓库，确保文档与代码一致。
项目概述
HaloLight 是一套多框架实现的企业级管理后台解决方案。参考实现：
其余框架 (Angular、Nuxt、SvelteKit、Astro、Solid、Qwik、Remix、Preact、Lit、Fresh) 均已实现并部署，预览地址见各仓库 README。
框架版本
| 框架 | 状态 | 预览 | 仓库 | 文档 |
|---|---|---|---|---|
| 🟦 Next.js 14 | ✅ 已部署 | 预览 | GitHub | 指南 |
| 💚 Vue 3.5 | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🔺 Angular 21 | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🌿 Nuxt 4 | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🧡 SvelteKit 2 | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🪐 Astro 5 | ✅ 已部署 | 预览 | GitHub | 指南 |
| 💠 Solid.js | ✅ 已部署 | 预览 | GitHub | 指南 |
| ⚡ Qwik | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🎸 Remix | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🪶 Preact | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🔥 Lit | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🦖 Fresh (Deno) | 📦 已归档 | 预览 | GitHub | 指南 |
后端服务
| 服务 | 状态 | 预览 | 仓库 | 文档 |
|---|---|---|---|---|
| 🦕 Deno + Hono | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🐹 Go API | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🟩 Node.js API | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🛠️ Admin 面板 | 🔒 私有 | 预览 | GitHub | 指南 |
部署方案
| 平台 | 状态 | 预览 | 仓库 | 文档 |
|---|---|---|---|---|
| ☁️ Cloudflare | ✅ 已部署 | 预览 | GitHub | 指南 |
| ▲ Vercel | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🔷 Netlify | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🐳 Docker | ✅ 已部署 | - | GitHub | 指南 |
| 🚂 Railway | ✅ 已部署 | 预览 | GitHub | 指南 |
| ✈️ Fly.io | ✅ 已部署 | 预览 | GitHub | 指南 |
| ☁️ Azure | ✅ 已部署 | 预览 | GitHub | 指南 |
| 🟠 AWS | ✅ 已部署 | 预览 | GitHub | 指南 |
核心特性
- 可拖拽仪表盘 - 自定义布局的 Dashboard 系统
- 权限控制 - RBAC 权限管理，支持通配符
- 主题系统 - 11 种皮肤预设 + 明暗模式
- Mock 数据 - 开发环境完整数据模拟
- 组件库 - 基于 shadcn/ui 30+ 组件
开发
bash
# 安装依赖
pnpm install
# 启动开发服务器
pnpm dev
# 构建生产版本
pnpm build
# 预览构建结果
pnpm preview文档结构
docs/
├── .vitepress/ # VitePress 配置
│ ├── config.ts # 主配置
│ ├── nav.ts # 导航栏配置
│ ├── sidebar.ts # 侧边栏配置
│ ├── head.ts # HTML head 配置
│ └── pwa.ts # PWA 配置
├── guide/ # 使用指南
│ ├── index.md # 简介
│ ├── getting-started.md # 快速开始
│ ├── nextjs.md # 🟦 Next.js
│ ├── vue.md # 💚 Vue
│ ├── angular.md # 🔺 Angular
│ ├── nuxt.md # 🌿 Nuxt
│ ├── sveltekit.md # 🧡 SvelteKit
│ ├── astro.md # 🪐 Astro
│ ├── solidjs.md # 💠 Solid.js
│ ├── qwik.md # ⚡ Qwik
│ ├── remix.md # 🎸 Remix
│ ├── preact.md # 🪶 Preact
│ ├── lit.md # 🔥 Lit
│ ├── fresh.md # 🦖 Fresh (Deno)
│ ├── deno.md # 🦕 Deno + Hono
│ ├── api-go.md # 🐹 Go API
│ ├── api-node.md # 🟩 Node.js API
│ ├── admin.md # 🛠️ Admin 面板
│ ├── cloudflare.md # ☁️ Cloudflare
│ ├── vercel.md # ▲ Vercel
│ ├── netlify.md # 🔷 Netlify
│ ├── docker.md # 🐳 Docker
│ ├── railway.md # 🚂 Railway
│ ├── fly.md # ✈️ Fly.io
│ ├── azure.md # ☁️ Azure
│ └── aws.md # 🟠 AWS
├── development/ # 开发文档
│ ├── index.md # 开发概览
│ ├── architecture.md # 整体架构
│ ├── components.md # 组件规范
│ ├── state-management.md # 状态管理
│ ├── api-patterns.md # API 设计
│ ├── authentication.md # 认证系统
│ ├── dashboard.md # 仪表盘
│ ├── theming.md # 主题系统
│ └── implementation-guide.md # 实现指南
├── public/ # 静态资源
└── index.md # 首页技术栈
- VitePress - 静态站点生成器
- Vue 3 - 渐进式 JavaScript 框架
- TypeScript - 类型安全
- Pagefind - 全文搜索
- Giscus - 评论系统
- PWA - 渐进式 Web 应用
贡献指南
欢迎提交 Issue 和 Pull Request！
- Fork 本仓库
- 创建功能分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'feat: add amazing feature') - 推送分支 (
git push origin feature/amazing-feature) - 创建 Pull Request
