Files
homepage/README.md
T

50 lines
1.4 KiB
Markdown
Raw Normal View History

2026-05-27 09:21:12 +08:00
# OnixByte Homepage
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
The official OnixByte site — a central hub for technical blogs, project documentation, and development standards.
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
## Tech Stack
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
A static documentation site built with [Rspress](https://rspress.dev/), supporting bilingual content (`en-gb` / `zh-hans`). All pages are authored in Markdown / MDX.
## URLs
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
| Domain | Recommended For |
|---|---|
| [onixbyte.cn](https://onixbyte.cn) | Users in mainland China |
| [onixbyte.com](https://onixbyte.com) | Users outside mainland China |
| [onixbyte.github.io](https://onixbyte.github.io) | Global (GitHub Pages fallback) |
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
## Local Development
2026-05-19 21:45:20 -05:00
```bash
2026-05-27 09:21:12 +08:00
pnpm install
pnpm dev # Start dev server with HMR
pnpm build # Production build, outputs to dist/
pnpm preview # Preview the production build locally
pnpm lint # ESLint
pnpm format # Prettier — format all files
2026-05-19 21:45:20 -05:00
```
2026-05-27 09:21:12 +08:00
## Directory Structure
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
```
docs/
├── public/ # Static assets (logos, icons, etc.)
├── en-gb/ # English content
│ ├── blogs/ # Technical blog posts
│ ├── projects/ # Project documentation
│ └── notifications/ # Announcements
└── zh-hans/ # Simplified Chinese content
├── blogs/
├── projects/
└── notifications/
2026-05-19 21:45:20 -05:00
```
2026-05-27 09:21:12 +08:00
## Deployment
2026-05-19 21:45:20 -05:00
2026-05-27 09:21:12 +08:00
Pushing to the `main` branch triggers a GitHub Actions workflow that builds the site and deploys it to GitHub Pages.
## Licence
MIT