Skip to content

halolight/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

33 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

HaloLight Docs

English | ็ฎ€ไฝ“ไธญๆ–‡

Deploy License VitePress Node pnpm Website

HaloLight ๅคšๆก†ๆžถ็ฎก็†ๅŽๅฐ้กน็›ฎๆ–‡ๆกฃ็ซ™็‚น๏ผŒๅŸบไบŽ VitePress ๆž„ๅปบ๏ผŒๆ”ฏๆŒไธญ่‹ฑๆ–‡ๅŒ่ฏญใ€‚

้กน็›ฎๅ…ณ็ณป

  • halolight/docs๏ผšๆ–‡ๆกฃไธŽ่ง„่Œƒ็š„ๅ”ฏไธ€ๆฅๆบ๏ผŒๅฎšไน‰่ทจๆก†ๆžถ็š„่ฎพ่ฎกใ€ๆŽฅๅฃๅ’Œๆœ€ไฝณๅฎž่ทต
  • halolight/halolight๏ผšNext.js 14 ๅ‚่€ƒๅฎž็Žฐ๏ผŒ้ชŒ่ฏ่ง„่Œƒ็š„ React ่ทฏๅพ„
  • halolight/halolight-vue๏ผšVue 3.5 ๅ‚่€ƒๅฎž็Žฐ๏ผŒ้ชŒ่ฏ่ง„่Œƒ็š„ Vue ่ทฏๅพ„

่ง„่Œƒๆ›ดๆ–ฐไผ˜ๅ…ˆๅœจๆœฌไป“ๅบ“่ฝๅœฐ๏ผŒๅ†ๅŒๆญฅๅˆฐๅฏนๅบ”ๅฎž็Žฐไป“ๅบ“๏ผŒ็กฎไฟๆ–‡ๆกฃไธŽไปฃ็ ไธ€่‡ดใ€‚

้กน็›ฎๆฆ‚่ฟฐ

HaloLight ๆ˜ฏไธ€ๅฅ—ๅคšๆก†ๆžถๅฎž็Žฐ็š„ไผไธš็บง็ฎก็†ๅŽๅฐ่งฃๅ†ณๆ–นๆกˆใ€‚ๅ‚่€ƒๅฎž็Žฐ๏ผš

ๆ‰€ๆœ‰ 14 ไธชๅ‰็ซฏๆก†ๆžถใ€7 ไธชๅŽ็ซฏ APIใ€8 ไธช้ƒจ็ฝฒๆ–นๆกˆๅ‡ๅทฒๅฎž็Žฐๅนถ้ƒจ็ฝฒ๏ผŒ้ข„่งˆๅœฐๅ€่งๅ„ไป“ๅบ“ READMEใ€‚

ๆก†ๆžถ็‰ˆๆœฌ

ๆก†ๆžถ ็Šถๆ€ ้ข„่งˆ ไป“ๅบ“ ๆ–‡ๆกฃ
๐ŸŸฆ Next.js 14 โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
โš›๏ธ React (Vite) โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ 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 โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—

ๅŽ็ซฏ API

ๅŽ็ซฏๆŠ€ๆœฏ ็Šถๆ€ ้ข„่งˆ ไป“ๅบ“ ๆ–‡ๆกฃ
๐Ÿฆœ NestJS 11 โœ… ๅทฒ้ƒจ็ฝฒ API Docs GitHub ๆŒ‡ๅ—
๐Ÿ Python FastAPI โœ… ๅทฒ้ƒจ็ฝฒ API Docs GitHub ๆŒ‡ๅ—
โ˜• Java Spring Boot โœ… ๅทฒ้ƒจ็ฝฒ API Docs GitHub ๆŒ‡ๅ—
๐Ÿน Go Fiber โœ… ๅทฒ้ƒจ็ฝฒ API Docs GitHub ๆŒ‡ๅ—
๐ŸŸฉ Node.js Express โœ… ๅทฒ้ƒจ็ฝฒ - GitHub ๆŒ‡ๅ—
๐Ÿ˜ PHP Laravel โœ… ๅทฒ้ƒจ็ฝฒ - GitHub ๆŒ‡ๅ—
๐Ÿž Bun + Hono โœ… ๅทฒ้ƒจ็ฝฒ - GitHub ๆŒ‡ๅ—

ไธญ้—ดๅฑ‚ / ๅ…จๆ ˆ

้กน็›ฎ ็Šถๆ€ ่ฏดๆ˜Ž ไป“ๅบ“ ๆ–‡ๆกฃ
๐Ÿ”— tRPC BFF โœ… ๅทฒ้ƒจ็ฝฒ ็ฑปๅž‹ๅฎ‰ๅ…จ API ็ฝ‘ๅ…ณ GitHub ๆŒ‡ๅ—
โšก Next.js Action โœ… ๅทฒ้ƒจ็ฝฒ Server Actions ๅ…จๆ ˆๆ–นๆกˆ GitHub ๆŒ‡ๅ—

้ƒจ็ฝฒๆ–นๆกˆ

ๅนณๅฐ ็Šถๆ€ ้ข„่งˆ ไป“ๅบ“ ๆ–‡ๆกฃ
โ˜๏ธ Cloudflare โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
โ–ฒ Vercel โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
๐Ÿ”ท Netlify โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
๐Ÿณ Docker โœ… ๅทฒ้ƒจ็ฝฒ - GitHub ๆŒ‡ๅ—
๐Ÿš‚ Railway โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
โœˆ๏ธ Fly.io โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
โ˜๏ธ Azure โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—
๐ŸŸ  AWS โœ… ๅทฒ้ƒจ็ฝฒ ้ข„่งˆ GitHub ๆŒ‡ๅ—

ๆ‰ฉๅฑ•้กน็›ฎ

้กน็›ฎ ็Šถๆ€ ่ฏดๆ˜Ž ไป“ๅบ“ ๆ–‡ๆกฃ
๐ŸŽจ UI ็ป„ไปถๅบ“ โœ… ๅทฒ้ƒจ็ฝฒ Stencil Web Components GitHub ๆŒ‡ๅ—
๐Ÿค– AI ๅŠฉ็† ๐Ÿšง ๅผ€ๅ‘ไธญ RAG + ๅŠจไฝœๆ‰ง่กŒ GitHub ๆŒ‡ๅ—
โ‚ฟ Web3 ้›†ๆˆ ๐Ÿšง ๅผ€ๅ‘ไธญ ้’ฑๅŒ…็™ปๅฝ• + ้“พไธŠๆ•ฐๆฎ GitHub ๆŒ‡ๅ—

ๆ ธๅฟƒ็‰นๆ€ง

  • ๅฏๆ‹–ๆ‹ฝไปช่กจ็›˜ - ่‡ชๅฎšไน‰ๅธƒๅฑ€็š„ Dashboard ็ณป็ปŸ
  • ๆƒ้™ๆŽงๅˆถ - RBAC ๆƒ้™็ฎก็†๏ผŒๆ”ฏๆŒ้€š้…็ฌฆ
  • ไธป้ข˜็ณป็ปŸ - 11 ็ง็šฎ่‚ค้ข„่ฎพ + ๆ˜Žๆš—ๆจกๅผ
  • Mock ๆ•ฐๆฎ - ๅผ€ๅ‘็ŽฏๅขƒๅฎŒๆ•ดๆ•ฐๆฎๆจกๆ‹Ÿ
  • ็ป„ไปถๅบ“ - ๅŸบไบŽ shadcn/ui 30+ ็ป„ไปถ

ๅผ€ๅ‘

# ๅฎ‰่ฃ…ไพ่ต–
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๏ผ

  1. Fork ๆœฌไป“ๅบ“
  2. ๅˆ›ๅปบๅŠŸ่ƒฝๅˆ†ๆ”ฏ (git checkout -b feature/amazing-feature)
  3. ๆไบคๆ›ดๆ”น (git commit -m 'feat: add amazing feature')
  4. ๆŽจ้€ๅˆ†ๆ”ฏ (git push origin feature/amazing-feature)
  5. ๅˆ›ๅปบ Pull Request

License

MIT ยฉ 2025 h7ml & HaloLight

About

๐Ÿ“š HaloLight ๅฎ˜ๆ–นๆ–‡ๆกฃ Documentation - ่ฎพ่ฎก่ง„่Œƒ, API ๆ–‡ๆกฃ, ๅผ€ๅ‘ๆŒ‡ๅ—, 35+ ้กน็›ฎๆจกๆฟ, VitePress โ†’ halolight.docs.h7ml.cn

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors