产品简介
bot-docs 基于VuePress构建的QQ机器人文档网站，提供开发指南、API参考和运营规范，适合机器人开发者和运营人员获取官方资料和参与社区共建。
核心功能
- 支持Gitpod在线开发和本地克隆开发
- 提供文档构建命令生成静态站点
- 文档结构清晰，包含开发、API和运营规范
- 欢迎通过PR参与文档共建
- 可加入QQ频道开发者社区获取支持
快速开始
- 克隆仓库：git clone git@github.com:tencent-connect/bot-docs.git
- 安装依赖：cd bot-docs && npm i
- 启动本地开发：npm run dev
界面预览
与其他方案对比
| 对比项 | 本工具 | 同类商业软件 | 在线服务 |
|---|---|---|---|
| 费用 | 开源免费 | 通常收费或含广告 | 可能有订阅或上传限制 |
| 隐私 | 本地运行，数据自持 | 依赖厂商政策 | 需上传数据到服务器 |
| 可定制性 | 源码开放，社区活跃 | 受限于官方功能 | 功能固定 |
适合谁用
- 需要开发QQ机器人的程序员
- 负责QQ机器人运营和规范的人员
- 希望贡献文档的开源爱好者
下载与版本
当前最新版本为 main，发布于 。支持 Windows、macOS、Linux。
⚠️ 注意：本项目仅提供源代码下载，不包含可直接运行的安装包（exe/dmg/apk 等。下载后需要自行编译构建才能使用，适合有一定开发经验的用户。如果你不熟悉编译流程，建议寻找同类开箱即用的替代方案。
注意事项
- 本工具仅供学习和研究使用，请遵守相关法律法规。
- 请尊重内容创作者版权，勿将下载内容用于商业或非法传播。
- 项目源码地址：https://github.com/tencent-connect/bot-docs