MaiMBot Documentation

This repository contains the official documentation for MaiMBot, an intelligent chatbot for QQ groups featuring LLM-based conversation capabilities, memory systems, and emotional expression.

About the Documentation

This documentation site is built with VitePress and covers everything you need to know about installing, configuring, and deploying MaiMBot.

Documentation Sections

• Installation guides (standard and beginner-friendly)
• API reference
• Deployment methods (Docker, Linux, Windows, Synology NAS)
• FAQs and troubleshooting
• File structure and configuration

Local Development

# Install dependencies
pnpm install

# Start development server
pnpm docs:dev

# Build for production
pnpm docs:build

# Preview production build
pnpm docs:preview

Contributing

Contributions to improve the documentation are welcome! Please feel free to submit pull requests or open issues for any improvements or corrections.