diff --git a/README.md b/README.md
index f094199cf..15a5c834e 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ npm install
完成后即可修改文档,修改完后使用以下命令本地启动:
```bash
-npm docs:dev
+npm run docs:dev
```
### 使用图片
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index 528779f59..9fc909747 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -20,8 +20,8 @@ export default defineConfig({
{
text: "概述",
items: [
+ { text: "新手指引(必看)", link: "/insight/guide" },
{ text: "项目介绍", link: "/insight/intro" },
- { text: "新手指引", link: "/insight/guide" },
],
},
{
@@ -34,17 +34,18 @@ export default defineConfig({
items: [
{ text: "手动部署", link: "/deploy/qchatgpt/manual" },
{ text: "Dokcer部署", link: "/deploy/qchatgpt/docker" },
+ { text: "社区资源", link: "/deploy/qchatgpt/community" }
],
},
{
text: "部署消息平台",
collapsed: true,
- link: "/deploy/platforms/",
+ // link: "/deploy/platforms/",
items: [
{
text: "aiocqhttp(推荐)",
collapsed: true,
- link: "/deploy/platforms/aiocqhttp/",
+ // link: "/deploy/platforms/aiocqhttp/",
items: [
{
text: "Lagrange",
@@ -125,7 +126,7 @@ export default defineConfig({
},
{
text: "开发",
- collapsed: true,
+ // collapsed: true,
items: [
{ text: "技术信息", link: "/develop/tech-info" },
{ text: "插件介绍", link: "/develop/plugin-intro" },
@@ -134,16 +135,16 @@ export default defineConfig({
{ text: "API参考", link: "/develop/api-ref" },
],
},
- {
- text: "规模化和商用",
- collapsed: true,
- link: "/tob/",
- items: [
- { text: "消息平台误导性", link: "/tob/platform" },
- { text: "AI内容合规性", link: "/tob/provider" },
- { text: "咨询方式", link: "/tob/contact" },
- ],
- },
+ // {
+ // text: "规模化和商用",
+ // // collapsed: true,
+ // // link: "/tob/",
+ // items: [
+ // { text: "消息平台误导性", link: "/tob/platform" },
+ // { text: "AI内容合规性", link: "/tob/provider" },
+ // { text: "咨询方式", link: "/tob/contact" },
+ // ],
+ // },
],
// 编辑链接
diff --git a/docs/deploy/platforms/aiocqhttp/lagrange.md b/docs/deploy/platforms/aiocqhttp/lagrange.md
index 60da1ef75..481b40c6f 100644
--- a/docs/deploy/platforms/aiocqhttp/lagrange.md
+++ b/docs/deploy/platforms/aiocqhttp/lagrange.md
@@ -1,18 +1,12 @@
-# 部署消息平台Lagrange的教程
+# 部署消息平台 Lagrange
## Lagrange介绍
Lagrange 是一个 QQNT 协议逆向工程框架,比 Shamrock 或 Mirai 更加轻便,在目前也较为稳定。通过 OneBot 11 协议接入,需选择使用`aiocqhttp`作为适配器,填写配置时可参考 Shamrock 的方式。
-可选平台(需要.NET 8 or 7支持):
-
-- Mac OS 也可使用
-- Linux Ubuntu 22.04,Debian 12应该都可以
-- Windows 10,11,Server2019及以上
-
-> 注意:
-> 要使用NT QQ发信息,旧版QQ无法正常使用
-
+::: warning
+需要使用 NT QQ 与机器人交互,旧版QQ无法正常使用
+:::
## 部署步骤
diff --git a/docs/deploy/platforms/aiocqhttp/llonebot.md b/docs/deploy/platforms/aiocqhttp/llonebot.md
index 4e3f8950c..4519a6a89 100644
--- a/docs/deploy/platforms/aiocqhttp/llonebot.md
+++ b/docs/deploy/platforms/aiocqhttp/llonebot.md
@@ -1,4 +1,4 @@
-# 部署消息平台LiteLoaderQQNT的教程
+# 部署消息平台 LiteLoaderQQNT
# LiteLoaderQQNT
diff --git a/docs/deploy/platforms/aiocqhttp/napcat.md b/docs/deploy/platforms/aiocqhttp/napcat.md
index 75f540722..15d9c8354 100644
--- a/docs/deploy/platforms/aiocqhttp/napcat.md
+++ b/docs/deploy/platforms/aiocqhttp/napcat.md
@@ -1,10 +1,4 @@
-# 部署消息平台NapCat的教程
-
-::: tip
-
-复活赛已打赢,继续使用
-
-:::
+# 部署消息平台 NapCat
## NapCat介绍
diff --git a/docs/deploy/platforms/aiocqhttp/shamrock.md b/docs/deploy/platforms/aiocqhttp/shamrock.md
index a89a247d8..4e1cd43cd 100644
--- a/docs/deploy/platforms/aiocqhttp/shamrock.md
+++ b/docs/deploy/platforms/aiocqhttp/shamrock.md
@@ -1,4 +1,4 @@
-# 部署消息平台shamrock的教程
+# 部署消息平台 shamrock
> 本文档仅为基本步骤,详细操作、答疑解惑及最新信息请前往[OpenShamrock官方文档](https://whitechi73.github.io/OpenShamrock/)。
diff --git a/docs/deploy/platforms/gocq.md b/docs/deploy/platforms/gocq.md
index 2fed8a0cc..ca957ae21 100644
--- a/docs/deploy/platforms/gocq.md
+++ b/docs/deploy/platforms/gocq.md
@@ -1,4 +1,4 @@
-# 部署消息平台go-cqhttp的教程
+# 部署消息平台 go-cqhttp
> 本文档仅为基本步骤,详细操作、答疑解惑及最新信息请前往[go-cqhttp官方文档](https://docs.go-cqhttp.org/)。
diff --git a/docs/deploy/platforms/index.md b/docs/deploy/platforms/index.md
deleted file mode 100644
index ac5bedcef..000000000
--- a/docs/deploy/platforms/index.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# 消息平台部署教程
-
-:::info 目录
-[[toc]]
-:::
-
-## 可选的平台适配器
-
-QChatGPT 需要一个中间程序,处理 QQ 等 IM 的协议(大部分是逆向工程)。
-以下平台任选,也可以配置多个,QChatGPT支持同时接入一个或多个平台:
-
-### 推荐
-
-- aiocqhttp(QQ):[aiocqhttp适配器教程](aiocqhttp/)
-- QQ官方API(QQ群、QQ频道):[QQ 官方 API 部署教程](official.md)
-
-### 不推荐
-
-以前流行的框架,现在长期不再维护或被腾讯严重围追堵截,不推荐使用:
-
-- Mirai(QQ):[Mirai部署教程](mirai.md) (使用旧版协议,风控严重)
-- go-cqhttp(QQ):[go-cqhttp部署教程(For nakuru)](nakuru.md)(使用旧版协议,[原开发者停止维护](https://github.com/Mrs4s/go-cqhttp?tab=readme-ov-file#%E9%87%8D%E8%A6%81%E4%BF%A1%E6%81%AF))
\ No newline at end of file
diff --git a/docs/deploy/platforms/mirai.md b/docs/deploy/platforms/mirai.md
index 4d15c4d9e..728d8b99c 100644
--- a/docs/deploy/platforms/mirai.md
+++ b/docs/deploy/platforms/mirai.md
@@ -1,4 +1,4 @@
-# 部署消息平台mirai的教程
+# 部署消息平台 mirai
> 本文档仅为基本步骤,详细操作、答疑解惑及最新信息请前往[Mirai官方代码库](https://github.com/mamoe/mirai)、[Mirai官方论坛](https://mirai.mamoe.net/)
diff --git a/docs/deploy/platforms/official.md b/docs/deploy/platforms/official.md
index d3dd07e15..6dce3191a 100644
--- a/docs/deploy/platforms/official.md
+++ b/docs/deploy/platforms/official.md
@@ -1,10 +1,7 @@
-# 使用 QQ 官方机器人 API 的教程
+# 使用 QQ 官方机器人 API
-QQ 官方 API 可以将机器人接入 QQ 频道 和 QQ 群。
QQ官方机器人所有人均可申请,可以在频道和群聊中使用,私聊也可。
-(之前个人创建的机器人是没有此群聊权限的,只要重新申请创建一个即可)
-
## 注册 QQ 机器人
前往[QQ开放平台](https://q.qq.com/#/),找到下方的 QQ 机器人文档,按照指引注册 QQ 频道机器人。
diff --git a/docs/deploy/index.md b/docs/deploy/qchatgpt/community.md
similarity index 63%
rename from docs/deploy/index.md
rename to docs/deploy/qchatgpt/community.md
index 5e7aedfd9..590895212 100644
--- a/docs/deploy/index.md
+++ b/docs/deploy/qchatgpt/community.md
@@ -1,38 +1,27 @@
-# 部署教程
-
-## 部署教程
-
-请按照以下步骤部署 QChatGPT 项目:
-
-- 第一步: [部署QChatGPT](qchatgpt/)
-- 第二步: [部署消息平台](platforms/)
-- 第三步: [填写配置信息](config.md)
-
-完成以上三个步骤后,你接下来应该仔细阅读左栏中的[配置详解](../config/README.md)和[元数据配置](../metadata/README.md),实现更多样化的配置需求
-
-## 社区资源
-
-### 视频教程
-
- [【8月最新】5min部署 最强AI语音聊天+酒馆角色扮演+QQ机器人,全新角色扮演语音聊天QQ机器人](https://www.bilibili.com/video/BV1vypZeBEW1/?share_source=copy_web&vd_source=1335a044d4fd926920999a0e3ba0a731)
-
-
-## 本项目交流 QQ 群
-
-### 社区群
-
-> 遇到问题请先认真阅读文档,如无法解决再加群提问
-
-Lazy的交流群一:891448839(已满)
-
-Lazy的交流群二:738382634(已满)
-
-Lazy的交流群三:248432104(已满)
-
-Lazy的交流群四:619154800 ([链接](https://qm.qq.com/q/1K9GjQuza))
-
-### 官方群
-
-> 官方群不解答部署问题
-
+# 社区资源
+
+
+## 视频教程
+
+ [【8月最新】5min部署 最强AI语音聊天+酒馆角色扮演+QQ机器人,全新角色扮演语音聊天QQ机器人](https://www.bilibili.com/video/BV1vypZeBEW1/?share_source=copy_web&vd_source=1335a044d4fd926920999a0e3ba0a731)
+
+
+## 本项目交流 QQ 群
+
+### 社区群
+
+> 遇到问题请先认真阅读文档,如无法解决再加群提问
+
+Lazy的交流群一:891448839(已满)
+
+Lazy的交流群二:738382634(已满)
+
+Lazy的交流群三:248432104(已满)
+
+Lazy的交流群四:619154800 ([链接](https://qm.qq.com/q/1K9GjQuza))
+
+### 官方群
+
+> 官方群不解答部署问题
+
四群:195992197 [链接](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=cSekvWmyezfCE4O8gXS7lSjkmPinjzpP&authKey=G4jHfz2%2BtQawxCRhn1ZRrQiI8bTvlepQubZL6F9fymFuz8jqZZ4FkYh6lhKLMCd9&noverify=0&group_code=195992197)
\ No newline at end of file
diff --git a/docs/deploy/qchatgpt/docker.md b/docs/deploy/qchatgpt/docker.md
index 396a94858..b7d007e7c 100644
--- a/docs/deploy/qchatgpt/docker.md
+++ b/docs/deploy/qchatgpt/docker.md
@@ -1,9 +1,5 @@
# Docker部署(仅推荐在Linux上使用)
-:::info 目录
-[[toc]]
-:::
-
:::warning
请您确保您**确实**需要 Docker 部署,您**必须**具有以下能力:
- 了解 `Docker` 和 `Docker Compose` 的使用
@@ -16,7 +12,7 @@
**不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。
:::
-:::note
+:::info
请先确保 Docker 和 Docker Compose 已安装
:::
diff --git a/docs/deploy/qchatgpt/index.md b/docs/deploy/qchatgpt/index.md
deleted file mode 100644
index 53f65acbd..000000000
--- a/docs/deploy/qchatgpt/index.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# QChatGPT部署教程
-
-:::info 目录
-[[toc]]
-:::
-
-选择一种部署 QChatGPT 的方式。
-
-## 手动部署
-
-- [ 点击查看手动部署的具体操作](manual.md)
-
-## Docker部署
-
-- [ 点击查看Docker部署的具体操作](docker.md)
\ No newline at end of file
diff --git a/docs/deploy/qchatgpt/manual.md b/docs/deploy/qchatgpt/manual.md
index 218a8d41d..cb45cff8c 100644
--- a/docs/deploy/qchatgpt/manual.md
+++ b/docs/deploy/qchatgpt/manual.md
@@ -1,14 +1,9 @@
# 手动部署(推荐,可以在所有平台上使用)
:::warning
-请使用Python 3.10.1(不包含3.10.0)及以上版本,推荐3.10.9版本,没有Python的需自行安装,参考[此教程](./more-details/python.md)
+请使用Python 3.10.1(不包含3.10.0)及以上版本,推荐3.10.14版本,没有Python的需自行安装。
:::
-:::info 目录
-[[toc]]
-:::
-
-
## 安装主程序
diff --git a/docs/deploy/qchatgpt/more-details/python.md b/docs/deploy/qchatgpt/more-details/python.md
deleted file mode 100644
index ef95920c2..000000000
--- a/docs/deploy/qchatgpt/more-details/python.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# Python的安装教程(QChatGPT)
-
-## 第一步:安装Python
-
-打开这个网址,[点我跳转](https://www.python.org/downloads/release/python-3109/)
-
-翻到最下边,点击这个下载python安装器
-
-
-
-然后,双击打开你刚才下载的,记得勾选下面的
-
-
-
-然后,所有项保持默认即可
-
-## 第二步:检测Python是否安装成功
-
-按win+R键,输入cmd,回车,在输入python,回车
-
-
-
-提示如图时,表明安装成功了
\ No newline at end of file
diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md
index 11191a22b..75f355adc 100644
--- a/docs/deploy/quick-config/config.md
+++ b/docs/deploy/quick-config/config.md
@@ -9,11 +9,11 @@
## platform.json
修改此配置文件以指定需要连接的消息平台,只需要关注`platform-adapters`字段。
-目前支持 `mirai`、`go-cqhttp`、`aiocqhttp`、`qq-botpy` 四种消息平台适配器,也可以同时启用多个同种类或不同种类的平台适配器
+目前支持 `mirai`、`go-cqhttp`、`aiocqhttp`、`qq-botpy` 四种消息平台适配器,也可以同时启用多个同种类或不同种类的平台适配器。
+请根据你部署的消息平台的情况选择填写。
### aiocqhttp 适配器
-如果你刚刚已经在 QChatGPT 的配置文件中启用了 aiocqhttp 适配器,那么你可以跳过这一步。
用于接入 Lagrange 等兼容 OneBot 协议的机器人框架(仅支持反向ws)。
```json
@@ -48,12 +48,13 @@
"secret": "",
"intents": [
"public_guild_messages",
- "direct_message"
+ "direct_message",
+ "public_messages"
]
}
```
-`"adapter": "qq-botpy"`,无需动,表明是接入`QQ官方机器人`的配置
+`"adapter": "qq-botpy"`,无需改动。
`enable`:是否启用,配置完成后请将其设为`true`
@@ -65,7 +66,7 @@
- `public_guild_messages` QQ 频道消息
- `direct_message` QQ 频道私聊消息
-- `public_messages` Q群消息(需要权限,具体请查看[QQ官方机器人API文档](https://q.qq.com/))
+- `public_messages` Q群 和 列表私聊消息
### YiriMirai 适配器
@@ -82,7 +83,7 @@
},
```
-`"adapter": "yiri-mirai"`,无需动,表明是接入`mirai`的配置
+`"adapter": "yiri-mirai"`,无需改动。
`enable`:是否启用,配置完成后请将其设为`true`
@@ -109,7 +110,7 @@
},
```
-`"adapter": "nakuru"`,无需动,表明是接入`go-cqhttp`的配置
+`"adapter": "nakuru"`,无需改动。
`enable`:是否启用,配置完成后请将其设为`true`
@@ -127,7 +128,7 @@
> 如果你没有OpenAI API Key,你可以[在此获取](https://ai.lazyshare.top/)
-以下仅讲解启用 OpenAI 接口的方式,具体设置方法请查看 [配置详解模块的`provider.json` 页](../config/provider.md)。
+以下仅讲解启用 OpenAI 接口的方式,具体设置方法请查看 [功能配置`provider.json` 页](/config/function/provider.html)。
编辑 `data/provider.json`,在`keys`->`openai`中添加你的 OpenAI API Key,例如:
@@ -172,6 +173,6 @@
::: tip
-阅读并完成以上教程后,你应该可以成功使用QChatGPT了,如果不能请再次阅读(你或许漏做或错做某些步骤),如果完全阅读并充分理解本文档后仍然确实无法使用,你可以在[这里](./README.md)找到交流群
+阅读并完成以上教程后,你应该可以成功使用QChatGPT了,如果不能请再次阅读(你或许漏做或错做某些步骤),如果完全阅读并充分理解本文档后仍然确实无法使用,你可以在[这里](/deploy/qchatgpt/community.html)找到交流群
:::
\ No newline at end of file
diff --git a/docs/insight/guide.md b/docs/insight/guide.md
index fcb753c42..4e1881f9a 100644
--- a/docs/insight/guide.md
+++ b/docs/insight/guide.md
@@ -1,32 +1,13 @@
-# 新手指引
-
-> 此页面旨在引导新用户如何阅读文档
-
-## 阅读顺序
-
-### 新用户的:
-
-对于新用户,我们建议如下阅读顺序
+# 阅读指引
1. 部署板块
- - 首先部署QChatGPT,使用手动部署或Docker部署,或者使用社区资源提供的一键部署(通常是最简部署方式,适合纯小白)
- - 接着部署消息平台,建议aiocqhttp
- - 最后填写配置信息(此时是最简上手配置,进一步使用仍需阅读配置板块)
+ - 阅读 部署 QChatGPT 页,根据个人情况选择部署方式
+ - 阅读 部署消息平台页
+ - 阅读 填写配置信息页,根据情况填写配置
2. 使用板块
- - 进行上面的最基础部署后
- - 阅读命令语法可以获得机器人的指令,可以在对话中实现切换预设、切换模型等
+ - 阅读命令语法了解机器人可用命令,可以在对话中实现切换预设、切换模型等
- 阅读插件列表,获得插件,增强功能
- 阅读常见问题,可有助于解决部署和使用时的问题
3. 配置板块
- - 功能配置,是部署板块配置信息部分的进一步拓展,具体解释了所有的配置信息,实现更多自定义需求
+ - 功能配置,具体解释所有的配置信息,实现更多自定义需求
- 元数据配置,控制敏感词、模型列表等
-
-通常来说,对于非开发人员和商用合作用途,上面的已经足够了。
-
-### 开发者的:
-
-对于开发者,包括但不限于项目主体开发和插件开发,我们建议再阅读上述配置后,继续阅读开发板块
-
-### 商业合作的
-
-请阅读规模化和商用板块
diff --git a/package-lock.json b/package-lock.json
index b74ad8a5c..7a583c02a 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,5 +1,5 @@
{
- "name": "QChatGPT-VitePress",
+ "name": "QChatGPT-Wiki",
"lockfileVersion": 3,
"requires": true,
"packages": {