Add files via upload

Author: luminous-ChenXi

README.md

@@ -1,70 +1,324 @@
 # AstrNest Documentation
 
-This is the static documentation site for AstrNest, deployed via GitHub Pages.
+[![VitePress](https://img.shields.io/badge/VitePress-1.6.4-blue.svg)](https://vitepress.dev/)
+[![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
-## 📖 About
+Official documentation for AstrNest - A modern image hosting platform built with Spring Boot 3.4.1 and Vue 3.5.24.
 
-AstrNest is a modern full-stack image hosting platform built with Spring Boot 3.4.1 and Vue 3.5.24. It provides comprehensive image management capabilities with multi-cloud storage support, advanced security features, and a modern user interface.
+## 📖 About AstrNest
 
-## 🌐 Live Site
+AstrNest is an enterprise-grade image hosting solution that provides:
 
-Visit the live documentation at: [https://luminous-ChenXi.github.io/astrnest](https://luminous-ChenXi.github.io/astrnest)
+- **Multi-cloud storage** support (Local, Aliyun OSS, Tencent COS)
+- **Modern architecture** with Spring Boot 3.4.1 + Vue 3.5.24
+- **Enterprise security** with role-based access control
+- **Responsive design** built with Tailwind CSS
+- **Comprehensive API** with RESTful design
 
-## 📚 Documentation Structure
+##  Quick Start
 
-### Chinese Documentation (中文文档)
-- **首页**: `/` - 项目介绍和快速开始
-- **部署指南**: `/deploy/` - 多种部署方式说明
-- **API文档**: `/api/` - 完整的API接口文档
-- **配置指南**: `/config/` - 系统配置说明
-- **常见问题**: `/faq` - 常见问题解答
+### Prerequisites
 
-### English Documentation
-- **Home**: `/en/` - Project introduction and quick start
-- **Deployment Guide**: `/en/deploy/` - Multiple deployment methods
-- **API Documentation**: `/en/api/` - Complete API interface documentation
-- **Configuration Guide**: `/en/config/` - System configuration instructions
-- **FAQ**: `/en/faq` - Frequently asked questions
+- Node.js 18.0 or higher
+- npm 8.0 or higher
+- Git
 
-## 🚀 Features
+### Installation
 
-- **Multi-cloud Storage**: Support for local, Alibaba Cloud OSS, Tencent Cloud COS, etc.
-- **AI Content Review**: Integrated with Tencent Cloud Data Processing
-- **Enterprise Security**: JWT authentication, role-based access control
-- **Modern UI**: Built with Vue 3, Element Plus, and Tailwind CSS
-- **Complete API Ecosystem**: RESTful APIs with API key authentication
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/luminous-ChenXi/astrnest.git
+   cd astrnest-docs
+   ```
 
-## 🔧 Technology Stack
+2. **Install dependencies**
+   ```bash
+   npm install
+   ```
 
-### Backend
-- Spring Boot 3.4.1
-- Java 21
-- MySQL 5.7+/8.0
-- Spring Security 6
+3. **Start development server**
+   ```bash
+   npm run dev
+   ```
 
-### Frontend
-- Vue 3.5.24
-- Vite 5.4.10
-- Element Plus 2.8.6
-- Tailwind CSS 3
+4. **Open your browser**
+   Navigate to `http://localhost:5173`
+
+##  Documentation Structure
+
+```
+astrnest-docs/
+├── docs/                    # Documentation source
+│   ├── .vitepress/         # VitePress configuration
+│   │   ├── config.js       # Main configuration
+│   │   └── config/         # Additional config files
+│   ├── public/             # Static assets
+│   ├── zh/                 # Chinese documentation
+│   │   ├── index.md        # Homepage
+│   │   ├── what-is-project.md
+│   │   ├── quick-start.md
+│   │   ├── faq.md
+│   │   └── api/            # API documentation
+│   └── en/                 # English documentation
+│       ├── index.md
+│       ├── what-is-project.md
+│       ├── quick-start.md
+│       ├── faq.md
+│       └── api/
+├── package.json            # Project configuration
+├── .eslintrc.js           # ESLint configuration
+├── .prettierrc.json       # Prettier configuration
+└── README.md              # This file
+```
+
+##  Development Commands
+
+### Development
+```bash
+# Start development server
+npm run dev
+
+# Alternative development command
+npm run docs:dev
+```
+
+### Build
+```bash
+# Build for production
+npm run build
+
+# Preview production build
+npm run preview
+
+# Serve built documentation
+npm run serve
+```
+
+### Code Quality
+```bash
+# Lint Markdown files
+npm run lint
+
+# Format code
+npm run format
+
+# Clean build directory
+npm run clean
+```
+
+### Testing
+```bash
+# Run tests
+npm run test
+
+# Build and prepare for deployment
+npm run deploy
+```
+
+##  Multi-language Support
+
+The documentation supports both Chinese and English:
+
+- **Chinese**: `/zh/` - 中文文档
+- **English**: `/en/` - English documentation
+
+### Adding New Languages
+
+1. Create a new directory under `docs/` (e.g., `docs/ja/` for Japanese)
+2. Copy the structure from existing language directories
+3. Update the language configuration in `docs/.vitepress/config.js`
+4. Add translations for all pages
+
+##  Writing Documentation
+
+### Markdown Features
+
+VitePress supports extended Markdown features:
+
+- **Vue components** in Markdown
+- **Custom containers** (tip, warning, danger, details)
+- **Code highlighting** with syntax themes
+- **Math expressions** with KaTeX
+- **Mermaid diagrams**
+
+### Example: Custom Container
+
+```md
+::: tip
+This is a tip message.
+:::
+
+::: warning
+This is a warning message.
+:::
+
+::: danger
+This is a dangerous operation.
+:::
+```
+
+### Example: Code Block
+
+````md
+```javascript
+// Example JavaScript code
+const message = 'Hello, AstrNest!';
+console.log(message);
+```
+````
+
+##  Customization
+
+### Theme Configuration
+
+Edit `docs/.vitepress/config.js` to customize:
+
+- **Colors and styles**
+- **Navigation and sidebar**
+- **Search functionality**
+- **Social links**
+- **Footer content**
+
+### Adding New Pages
+
+1. Create a new `.md` file in the appropriate language directory
+2. Add frontmatter with metadata:
+
+```yaml
+---
+layout: doc
+title: Your Page Title
+description: Page description for SEO
+---
+```
+
+3. Update sidebar configuration in the theme config
+
+##  Configuration Files
+
+### VitePress Config (`docs/.vitepress/config.js`)
+
+Main configuration file for:
+- Site metadata
+- Theme settings
+- Navigation structure
+- Plugin configuration
+
+### Head Config (`docs/.vitepress/config/head.js`)
+
+Configuration for:
+- Meta tags
+- Favicon
+- SEO optimization
+- Social media cards
+
+##  SEO Optimization
+
+The documentation is optimized for search engines with:
+
+- **Structured data** using JSON-LD
+- **Meta tags** for social sharing
+- **Sitemap generation**
+- **Canonical URLs**
+- **Open Graph tags**
+
+##  Deployment
+
+### Static Hosting (Recommended)
+
+1. **Build the documentation**
+   ```bash
+   npm run build
+   ```
+
+2. **Deploy to your hosting service**
+   - Netlify, Vercel, GitHub Pages, etc.
+
+### Docker Deployment
+
+```dockerfile
+FROM node:18-alpine
+WORKDIR /app
+COPY package*.json ./
+RUN npm ci --only=production
+COPY . .
+RUN npm run build
+EXPOSE 4173
+CMD ["npm", "run", "serve"]
+```
+
+### Manual Deployment
+
+1. Build the project
+2. Upload the `docs/.vitepress/dist` directory to your web server
+3. Configure your web server to serve the static files
+
+## 🤝 Contributing
+
+We welcome contributions to improve the AstrNest documentation!
+
+### How to Contribute
+
+1. **Fork the repository**
+2. **Create a feature branch**
+   ```bash
+   git checkout -b feature/amazing-feature
+   ```
+3. **Make your changes**
+4. **Commit your changes**
+   ```bash
+   git commit -m 'Add some amazing feature'
+   ```
+5. **Push to the branch**
+   ```bash
+   git push origin feature/amazing-feature
+   ```
+6. **Open a Pull Request**
+
+### Code Style
+
+- Follow the existing code style
+- Use meaningful commit messages
+- Add comments for complex logic
+- Update documentation when changing features
 
 ## 📄 License
 
-This project is licensed under the GNU General Public License v3 (GPL v3). See the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-## 🔗 Links
+## 🆘 Support
 
-- **GitHub Repository**: [https://github.com/luminous-ChenXi/astrnest](https://github.com/luminous-ChenXi/astrnest)
-- **Live Demo**: [https://luminous-ChenXi.github.io/astrnest](https://luminous-ChenXi.github.io/astrnest)
-- **Issue Tracker**: [https://github.com/luminous-ChenXi/astrnest/issues](https://github.com/luminous-ChenXi/astrnest/issues)
+### Documentation Issues
 
-## 📞 Support
+If you find issues with the documentation:
 
-If you encounter any issues or have questions:
-1. Check the [FAQ](/faq) section
-2. Search existing [issues](https://github.com/luminous-ChenXi/astrnest/issues)
-3. Create a new issue with detailed information
+1. Check the [FAQ](/faq) for common solutions
+2. Search existing [GitHub issues](https://github.com/luminous-ChenXi/astrnest-docs/issues)
+3. Create a new issue with details about the problem
+
+### AstrNest Platform Support
+
+For issues with the AstrNest platform itself:
+
+- **Documentation**: This documentation site
+- **GitHub**: [AstrNest Repository](https://github.com/luminous-ChenXi/astrnest)
+- **Email**: support@astrnest.com
+- **Community**: [Discussion Forum](https://github.com/luminous-ChenXi/astrnest/discussions)
+
+##  Useful Links
+
+- [AstrNest Main Project](https://github.com/luminous-ChenXi/astrnest)
+- [VitePress Documentation](https://vitepress.dev/)
+- [Spring Boot Documentation](https://spring.io/projects/spring-boot)
+- [Vue.js Documentation](https://vuejs.org/)
 
 ---
 
-*Last updated: 2026-02-03*
+<div align="center">
+
+**AstrNest Documentation** • Built with  using VitePress
+
+[Quick Start](/quick-start) • [API Reference](/api) • [Contributing](CONTRIBUTING.md)
+
+</div>