MaiMBot 文档

本仓库为 MaiMBot 的官方文档。MaiMBot 是一个智能聊天机器人，专为 QQ 群设计，具有基于 LLM 的对话能力、记忆系统和情感表达功能。

关于文档

此文档站点使用 VitePress 构建，涵盖了安装、部署、配置以及开发（未完成） MaiMBot 所需的所有内容。

文档部分

文档目录

• 安装指南 提供标准版和新手友好版的安装步骤，帮助用户快速上手。

• API 参考（未完成） 详细介绍 MaiMBot 提供的 API 接口及其使用方法。

• 部署方法 涵盖多种部署方式，包括 Docker、Linux、Windows 和群晖 NAS。

• 常见问题解答和故障排除 收录常见问题及其解决方案，帮助用户排查和解决问题。

• 文件结构和配置 说明项目的文件结构及配置方法，便于用户自定义和扩展。

本地开发

本地部署要求

使用Nodejs安装对应依赖

# 安装依赖
pnpm install

# 启动开发服务器
pnpm docs:dev

# 构建生产版本
pnpm docs:build

# 预览生产版本
pnpm docs:preview

贡献

完整方式

如果你想要修改文档，首先fork在修改后提出PR即可。

如果你想要添加文件，在fork后添加你写的文档并放入对应目录（或者新建目录），修改各级的index.md使其包含您的文档。

然后找到.vitepress下的config.mts文件，修改其中的导航使其能正确导航到你的文件。

随后发起PR即可

懒人方式

如果你想要修改文档，首先fork在修改后提出PR即可。

如果你想要添加文件，在fork后添加你写的文档并放入根目录，随后发起PR，说明你想放置的目录位置。

若PR通过，我们会手动帮你配置各类目录