AstrNest Documentation

Official documentation for AstrNest - A modern image hosting platform built with Spring Boot 3.4.1 and Vue 3.5.24.

📖 About AstrNest

AstrNest is an enterprise-grade image hosting solution that provides:

• 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

Quick Start

Prerequisites

• Node.js 18.0 or higher
• npm 8.0 or higher
• Git

Installation

1. Clone the repository

   git clone https://github.com/luminous-ChenXi/astrnest.git
   cd astrnest-docs

2. Install dependencies

   npm install

3. Start development server

   npm run dev

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

# Start development server
npm run dev

# Alternative development command
npm run docs:dev

Build

# Build for production
npm run build

# Preview production build
npm run preview

# Serve built documentation
npm run serve

Code Quality

# Lint Markdown files
npm run lint

# Format code
npm run format

# Clean build directory
npm run clean

Testing

# 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

::: tip
This is a tip message.
:::

::: warning
This is a warning message.
:::

::: danger
This is a dangerous operation.
:::

Example: Code Block

```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:

---
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

   npm run build

2. Deploy to your hosting service

   • Netlify, Vercel, GitHub Pages, etc.

Docker Deployment

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

   git checkout -b feature/amazing-feature

3. Make your changes
4. Commit your changes

   git commit -m 'Add some amazing feature'

5. Push to the branch

   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 MIT License - see the LICENSE file for details.

🆘 Support

Documentation Issues

If you find issues with the documentation:

1. Check the FAQ for common solutions
2. Search existing GitHub 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
• Email: support@astrnest.com
• Community: Discussion Forum

Useful Links

• AstrNest Main Project
• VitePress Documentation
• Spring Boot Documentation
• Vue.js Documentation

---

AstrNest Documentation • Built with using VitePress

Quick Start • API Reference • Contributing