关于本文档
本文档是什么
这里是 MaiBot 官方文档站，基于 VitePress 构建。从安装部署、配置、功能使用到插件和适配器开发，你需要的指南都在这里。文档支持中英双语（简体中文 / English），由社区贡献者一起维护。
文档结构
文档按功能模块组织，zh/ 和 en/ 目录镜像同步：
- 用户手册 (
manual/) — 部署安装（源码/Docker/一键包）、平台适配器配置（NapCat/GoCQ/Telegram/Discord）、Bot 与模型配置详解、功能使用说明、WebUI 管理操作 - 开发文档 (
develop/) — 技术栈与项目结构、架构设计（消息管线 / Maisaka 推理引擎 / 记忆系统 / 插件运行时等）、贡献指南、文档编写特性 - 插件开发 (
plugin/) — 插件 Manifest、生命周期、Tool/Command/Hook/Event 组件开发、API 参考 - 常见问题 (
faq/) — 部署、配置、模型、插件、数据迁移等 FAQ；错误排查指南 - 更新日志 (
changelog/) — 各版本更新记录 - 关于 (
about/) — 关于本项目、关于本文档、交流群、致谢与链接、EULA、隐私条款
技术栈
本文档站使用的技术与插件：
- VitePress — 基于 Vite 和 Vue 的静态网站生成器
- Mermaid — 通过
vitepress-plugin-mermaid支持流程图、时序图等 - vitepress-plugin-group-icons — 为代码组标签自动显示语言图标
- vitepress-markdown-timeline — 支持时间线
- Linkcard — 自定义链接卡片组件（已注册为全局组件
<Linkcard>，没指定 logo 时会自动显示链接图标） - xgplayer — 视频播放器组件
- vitepress-plugin-llms — 生成 llms.txt / llms-full.txt
- @nolebase/vitepress-plugin-enhanced-readabilities — 增强阅读体验
本地开发
bash
# 安装依赖
pnpm install
# 启动开发服务器
pnpm docs:dev
# 构建生产版本
pnpm docs:build
# 预览生产版本
pnpm docs:preview贡献方式
欢迎参与文档建设！你可以通过以下方式贡献：
- Fork 本仓库，修改或新增文档内容后提交 PR
- 新增文件后，修改所在目录的 index.md 使其包含你的文档
- 在
.vitepress/下修改 config.mts 或 sidebar 文件，确保导航能正确指向你的页面
详细的贡献流程可以参考本仓库 README 的"贡献"部分；如果想参与 MaiBot 代码开发，请参阅贡献指南。
文档编写特性
本站除了 VitePress 原生功能，还配置了一些额外的 Markdown 插件和自定义组件。准备写文档的话，建议先看看 文档编写特性 页，了解 Mermaid 图表、更新时间线、代码组图标、Linkcard 组件等特性的用法和约束。