About This Docs

Updated: 07/22/2026Word count: 0 wordsReading time: 1 min

What This Docs Is

This website is the official documentation for MaiBot, built with VitePress. It covers everything from installation, deployment, and configuration to plugin and adapter development. The documentation is bilingual (简体中文 / English) and maintained by community contributors.

Documentation Structure

The documentation is organized by module, with zh/ and en/ directories mirrored:

• User Manual (manual/) — Deployment and installation (source/Docker/one-click), adapter configuration (NapCat/GoCQ/Telegram/Discord), Bot and model configuration, feature guides, WebUI management
• Development (develop/) — Tech stack and project structure, architecture design (message pipeline / Maisaka reasoning engine / memory system / plugin runtime, etc.), contributing guide, markdown features
• Plugin Development (plugin/) — Plugin Manifest, lifecycle, Tool/Command/Hook/Event component development, API reference
• FAQ (faq/) — Deployment, configuration, models, plugins, data migration FAQs; troubleshooting guide
• Changelog (changelog/) — Version release notes
• About (about/) — About the Project, About This Docs, Community Groups, Acknowledgements & Links, EULA, Privacy Policy

Tech Stack

Technologies and plugins used by this documentation site:

• VitePress — Static site generator based on Vite and Vue
• Mermaid — Flowcharts, sequence diagrams, etc. via vitepress-plugin-mermaid
• vitepress-plugin-group-icons — Language icons for code group tabs
• vitepress-markdown-timeline — Timelines support
• Linkcard — Custom link card component (registered globally as <Linkcard>; automatically shows link favicon when logo is unspecified)
• xgplayer — Video player component
• vitepress-plugin-llms — Generates llms.txt / llms-full.txt
• @nolebase/vitepress-plugin-enhanced-readabilities — Enhanced reading experience

Local Development

Bash

# Install dependencies
pnpm install

# Start dev server
pnpm docs:dev

# Build for production
pnpm docs:build

# Preview production build
pnpm docs:preview

Contributing

You are welcome to contribute to the documentation! Here's how:

• Fork this repository, modify or add documentation content, and submit a PR
• After adding new files, update the relevant index.md to include your document
• Modify config.mts or sidebar files under .vitepress/ to ensure proper navigation to your pages

For the detailed documentation workflow, see the documentation repository README. Code contributions follow the MaiBot contribution guide.

Markdown Features

In addition to VitePress's native features, this site is configured with extra Markdown plugins and custom components. Contributors should first read the Markdown Features page to learn about Mermaid charts, timestamps, code group icons, the Linkcard component, and related conventions.

For the list of documentation contributors, see Acknowledgements & Links.