216 lines
5.4 KiB
Markdown
216 lines
5.4 KiB
Markdown
# Goodgo Documentation Website
|
|
|
|
Website chính thức của Goodgo Documentation - một blockchain bảo mật hậu lượng tử, tương thích EVM, được thiết kế cho bảo mật dài hạn và sẵn sàng cho Web3.
|
|
|
|
## 🌟 Giới thiệu
|
|
|
|
Goodgo Documentation là một blockchain thế hệ mới với các tính năng:
|
|
|
|
- **Post-Quantum Security**: Bảo mật hậu lượng tử với XMSS và ML-DSA
|
|
- **EVM Compatibility**: Tương thích hoàn toàn với Ethereum Virtual Machine
|
|
- **Web3-Ready**: Sẵn sàng cho hệ sinh thái Web3 và dApps
|
|
|
|
## ✨ Tính năng
|
|
|
|
### Trang chủ
|
|
- Hero section với 3D interactive scene
|
|
- Products showcase
|
|
- Features highlight (XMSS, ML-DSA, EVM Compatibility)
|
|
- Call-to-action sections
|
|
|
|
### Tài liệu (Documentation)
|
|
- Hệ thống docs đa ngôn ngữ (Tiếng Anh & Tiếng Việt)
|
|
- MDX-based content với syntax highlighting
|
|
- Navigation sidebar
|
|
- Search functionality
|
|
- Responsive design
|
|
|
|
### SEO & Performance
|
|
- ✅ Metadata đầy đủ (Open Graph, Twitter Cards)
|
|
- ✅ Sitemap tự động
|
|
- ✅ Robots.txt tối ưu
|
|
- ✅ Structured Data (JSON-LD)
|
|
- ✅ Hreflang tags cho đa ngôn ngữ
|
|
- ✅ Canonical URLs
|
|
|
|
### Internationalization (i18n)
|
|
- Hỗ trợ đa ngôn ngữ: Tiếng Anh (en) và Tiếng Việt (vi)
|
|
- URL-based locale routing (`/en`, `/vi`)
|
|
- Language switcher
|
|
|
|
## 🛠️ Công nghệ sử dụng
|
|
|
|
- **Framework**: [Next.js 16](https://nextjs.org/) với App Router
|
|
- **Language**: TypeScript
|
|
- **Styling**: CSS Modules
|
|
- **3D Graphics**: Three.js với React Three Fiber
|
|
- **Internationalization**: next-intl
|
|
- **Content**: MDX cho documentation
|
|
- **Icons**: Lucide React
|
|
|
|
## 📋 Yêu cầu hệ thống
|
|
|
|
- Node.js >= 20.0.0
|
|
- npm hoặc yarn hoặc pnpm
|
|
|
|
## 🚀 Bắt đầu
|
|
|
|
### Cài đặt dependencies
|
|
|
|
```bash
|
|
npm install
|
|
# hoặc
|
|
yarn install
|
|
# hoặc
|
|
pnpm install
|
|
```
|
|
|
|
### Chạy development server
|
|
|
|
```bash
|
|
npm run dev
|
|
# hoặc
|
|
yarn dev
|
|
# hoặc
|
|
pnpm dev
|
|
```
|
|
|
|
Mở [http://localhost:3000](http://localhost:3000) trong trình duyệt để xem kết quả.
|
|
|
|
### Build cho production
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
### Chạy production server
|
|
|
|
```bash
|
|
npm run start
|
|
```
|
|
|
|
## 📁 Cấu trúc Project
|
|
|
|
```
|
|
quaros-network-website/
|
|
├── content/
|
|
│ └── docs/ # MDX documentation files
|
|
│ ├── en/ # English docs
|
|
│ └── vi/ # Vietnamese docs
|
|
├── public/ # Static assets
|
|
├── src/
|
|
│ ├── app/ # Next.js App Router
|
|
│ │ ├── [locale]/ # Locale-based routing
|
|
│ │ │ ├── docs/ # Documentation pages
|
|
│ │ │ └── page.tsx # Home page
|
|
│ │ ├── sitemap.ts # Sitemap generation
|
|
│ │ └── robots.ts # Robots.txt
|
|
│ ├── components/ # React components
|
|
│ │ ├── common/ # Common components
|
|
│ │ ├── docs/ # Documentation components
|
|
│ │ ├── home/ # Home page components
|
|
│ │ └── layout/ # Layout components
|
|
│ ├── docs/ # Documentation config
|
|
│ ├── i18n/ # i18n configuration
|
|
│ └── messages/ # Translation files
|
|
│ ├── en.json
|
|
│ └── vi.json
|
|
├── next.config.mjs # Next.js configuration
|
|
├── vercel.json # Vercel deployment config
|
|
└── package.json
|
|
```
|
|
|
|
## 🌍 Cấu hình Environment Variables
|
|
|
|
Tạo file `.env.local` trong root directory:
|
|
|
|
```env
|
|
NEXT_PUBLIC_BASE_URL=https://quaros.network
|
|
```
|
|
|
|
## 📝 Thêm nội dung Documentation
|
|
|
|
1. Tạo file MDX trong `content/docs/{locale}/`
|
|
2. Thêm entry vào `src/docs/navigation.ts`
|
|
3. Thêm vào registry trong `src/docs/registry.ts` (nếu cần)
|
|
|
|
Ví dụ:
|
|
|
|
```mdx
|
|
---
|
|
title: "My New Doc"
|
|
---
|
|
|
|
# My New Documentation
|
|
|
|
Content here...
|
|
```
|
|
|
|
## 🎨 Styling
|
|
|
|
Project sử dụng CSS Modules cho styling. Mỗi component có file `.module.css` riêng.
|
|
|
|
## 🔍 SEO Configuration
|
|
|
|
### Metadata
|
|
Metadata được cấu hình trong:
|
|
- `src/app/[locale]/layout.tsx` - Layout metadata
|
|
- `src/app/[locale]/page.tsx` - Home page metadata
|
|
- `src/app/[locale]/docs/[[...slug]]/page.tsx` - Docs metadata
|
|
|
|
### Sitemap
|
|
Sitemap tự động được generate tại `/sitemap.xml` từ `src/app/sitemap.ts`
|
|
|
|
### Robots.txt
|
|
Robots.txt được generate tại `/robots.txt` từ `src/app/robots.ts`
|
|
|
|
## 🚢 Deployment
|
|
|
|
### Vercel (Recommended)
|
|
|
|
1. Push code lên GitHub
|
|
2. Import project vào Vercel
|
|
3. Cấu hình environment variables
|
|
4. Deploy tự động
|
|
|
|
**Lưu ý**: Đảm bảo Node.js version trong Vercel project settings là `20.x` hoặc `22.x`
|
|
|
|
### Cloudflare Pages
|
|
|
|
Project cũng hỗ trợ deploy trên Cloudflare Pages:
|
|
|
|
```bash
|
|
npm run pages:deploy
|
|
```
|
|
|
|
## 🧪 Development Scripts
|
|
|
|
- `npm run dev` - Chạy development server
|
|
- `npm run build` - Build production
|
|
- `npm run start` - Chạy production server
|
|
- `npm run lint` - Chạy ESLint
|
|
|
|
## 📚 Tài liệu tham khảo
|
|
|
|
- [Next.js Documentation](https://nextjs.org/docs)
|
|
- [next-intl Documentation](https://next-intl-docs.vercel.app/)
|
|
- [MDX Documentation](https://mdxjs.com/)
|
|
- [Three.js Documentation](https://threejs.org/docs/)
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
|
## 📄 License
|
|
|
|
[Thêm license nếu có]
|
|
|
|
## 🔗 Links
|
|
|
|
- Website: [quaros.network](https://quaros.network)
|
|
- Documentation: [quaros.network/docs](https://quaros.network/docs)
|
|
|
|
---
|
|
|
|
Made with ❤️ by Goodgo Documentation Team
|