HaloLight Docs
简体中文 | English
HaloLight multi-framework admin dashboard documentation site, built with VitePress, supporting bilingual (Chinese & English).
Project Relations
halolight/docs: The single source of truth for documentation and specifications, defining cross-framework design, interfaces, and best practiceshalolight/halolight: Next.js 14 reference implementation, validating the React pathhalolight/halolight-vue: Vue 3.5 reference implementation, validating the Vue path
Specification updates land here first, then sync to corresponding implementation repos to ensure documentation and code consistency.
Project Overview
HaloLight is an enterprise-grade admin dashboard solution with multi-framework implementations. Reference implementations:
Other frameworks (Angular, Nuxt, SvelteKit, Astro, Solid, Qwik, Remix, Preact, Lit, Fresh) are all implemented and deployed. See each repo's README for preview URLs.
Framework Versions
| Framework | Status | Preview | Repo | Docs |
|---|---|---|---|---|
| Next.js 14 | Deployed | Preview | GitHub | Guide |
| Vue 3.5 | Deployed | Preview | GitHub | Guide |
| Angular 21 | Deployed | Preview | GitHub | Guide |
| Nuxt 4 | Deployed | Preview | GitHub | Guide |
| SvelteKit 2 | Deployed | Preview | GitHub | Guide |
| Astro 5 | Deployed | Preview | GitHub | Guide |
| Solid.js | Deployed | Preview | GitHub | Guide |
| Qwik | Deployed | Preview | GitHub | Guide |
| Remix | Deployed | Preview | GitHub | Guide |
| Preact | Deployed | Preview | GitHub | Guide |
| Lit | Deployed | Preview | GitHub | Guide |
| Fresh (Deno) | Archived | Preview | GitHub | Guide |
Backend Services
| Service | Status | Preview | Repo | Docs |
|---|---|---|---|---|
| Deno + Hono | Deployed | Preview | GitHub | Guide |
| Go API | Deployed | Preview | GitHub | Guide |
| Node.js API | Deployed | Preview | GitHub | Guide |
| Admin Panel | Private | Preview | GitHub | Guide |
Deployment Options
| Platform | Status | Preview | Repo | Docs |
|---|---|---|---|---|
| Cloudflare | Deployed | Preview | GitHub | Guide |
| Vercel | Deployed | Preview | GitHub | Guide |
| Netlify | Deployed | Preview | GitHub | Guide |
| Docker | Deployed | - | GitHub | Guide |
| Railway | Deployed | Preview | GitHub | Guide |
| Fly.io | Deployed | Preview | GitHub | Guide |
| Azure | Deployed | Preview | GitHub | Guide |
| AWS | Deployed | Preview | GitHub | Guide |
Core Features
- Draggable Dashboard - Customizable layout Dashboard system
- Permission Control - RBAC permission management with wildcard support
- Theme System - 11 skin presets + light/dark mode
- Mock Data - Complete data simulation for development
- Component Library - 30+ components based on shadcn/ui
Development
bash
# Install dependencies
pnpm install
# Start development server
pnpm dev
# Build for production
pnpm build
# Preview build
pnpm previewDocumentation Structure
docs/
├── .vitepress/ # VitePress configuration
│ ├── config.ts # Main config
│ ├── nav.ts # Navigation config
│ ├── sidebar.ts # Sidebar config
│ ├── head.ts # HTML head config
│ └── pwa.ts # PWA config
├── guide/ # User guides (Chinese)
├── en/guide/ # User guides (English)
├── development/ # Development docs (Chinese)
├── en/development/ # Development docs (English)
├── public/ # Static assets
├── index.md # Homepage (Chinese)
└── en/index.md # Homepage (English)Tech Stack
- VitePress - Static Site Generator
- Vue 3 - Progressive JavaScript Framework
- TypeScript - Type Safety
- Pagefind - Full-text Search
- Giscus - Comment System
- PWA - Progressive Web App
Contributing
Contributions are welcome! Feel free to submit Issues and Pull Requests.
- Fork this repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'feat: add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Create a Pull Request
