Skip to content

Commit 96aad5b

Browse files
Sora233Sora233
committed
update docs
1 parent 6382feb commit 96aad5b

File tree

9 files changed

+120
-12
lines changed

9 files changed

+120
-12
lines changed

‎docs/.vuepress/config.js

+11-5
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,32 @@ module.exports = {
22
base: '/',
33
title: 'DDBOT 文档',
44
description: 'DDBOT 文档中心',
5+
plugins: {
6+
'@vuepress/back-to-top': {},
7+
'@vuepress/nprogress': {},
8+
'@vuepress/active-header-links': {},
9+
'@vuepress/medium-zoom': {
10+
selector: 'img',
11+
},
12+
},
513
themeConfig: {
614
repo: 'Sora233/DDBOT-docs',
715
repoLabel: '查看源码',
816
lastUpdated: '最后更新',
917
docsDir: 'docs',
1018
docsBranch: 'master',
1119
editLinks: true,
12-
editLinkText: '发现问题，救救SORA，我来改正此页面！',
20+
editLinkText: '救救SORA，我来完善此页面！',
1321
smoothScroll: true,
1422
sidebar: 'auto',
1523
displayAllHeaders: true,
16-
tip: "提示",
17-
warning: "注意",
18-
danger: "警告",
1924
backToHome: "返回首页",
2025
nav: [
2126
{text: '主页', link: '/'},
2227
{text: '命令指南', link: '/guide/'},
2328
{text: '部署指南', link: '/deploy/'},
2429
{text: '模板', link: '/template/'},
30+
{text: '需要帮助？', link: '/DDBOT-help/'}
2531
]
26-
}
32+
},
2733
}

‎docs/.vuepress/public/01_wrong_arch.jpg

8.54 KB
Loading

‎docs/.vuepress/public/02_login.jpg

58.6 KB
Loading

‎docs/DDBOT-help/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# 官方交流群
2+
3+
## 唯一指定交流群
4+
5+
**DD与BOT交流群：755612788**
6+
7+
# 友情链接
8+
9+
欢迎其他bot开发者/用户前来交流，你可以申请在此处放上你的链接。

‎docs/deploy/README.md

+71-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,71 @@
1-
# 部署指南
1+
# 部署指南
2+
3+
DDBOT的部署较为容易，只需几步，即可获得一个专属于你的DDBOT。
4+
5+
请按照下面的步骤依次进行。
6+
7+
## 准备工作
8+
9+
- 准备一台电脑，并装好浏览器。
10+
11+
- 准备一部手机，并装好手机QQ。
12+
13+
- 准备两个QQ帐号
14+
15+
你需要准备一个不常用的QQ（俗称小号），将这个QQ做为BOT帐号，**后面将使用`BOT帐号`代指这个QQ**。
16+
17+
另一个QQ号用来控制BOT，**后面将使用`管理员帐号`代指这个QQ**。
18+
19+
如果这两个QQ还不是好友，请手动互加好友。
20+
21+
- 就这么多，请继续看下一节
22+
23+
## 启动DDBOT
24+
25+
请访问DDBOT[下载页面](https://github.com/Sora233/DDBOT/releases/latest)。
26+
27+
下载页面中共有超过20个版本的DDBOT，这是因为DDBOT支持Windows、Linux、MacOS等多个平台以及不同架构。
28+
29+
你只需要下载一个适合你的版本即可。
30+
31+
如果你不知道哪个版本适合你，推荐选择`DDBOT-vX.X.X-windows-amd64.zip`。
32+
33+
## 运行DDBOT
34+
35+
如果你还没有解压下载好的DDBOT，请将它解压出来。**（请不要双击压缩包里的DDBOT来运行）**
36+
37+
将DDBOT程序放入一个单独的目录中，双击运行它，将会启动一个黑色命令框，第一次启动时将会花费几秒钟时间初始化，随后命令框内将显示一个二维码。
38+
39+
:::danger 错误
40+
如果你双击运行程序的时候出现：
41+
<img :src="$withBase('/01_wrong_arch.jpg')" alt="错误提示">
42+
说明你下载了不适合你的DDBOT版本，请确认你下载的是：`DDBOT-vX.X.X-windows-amd64.zip`
43+
:::
44+
45+
这时请拿出上一步准备好的手机，打开手机QQ，登录 **`BOT帐号`**，并用手机QQ扫描二维码。
46+
47+
观察黑色命令框，如果你看到命令框内有显示：
48+
49+
<img :src="$withBase('/02_login.jpg')" alt="登陆成功">
50+
51+
恭喜你，你已经成功启动了一个DDBOT。
52+
53+
现在，请保持DDBOT运行，同时使用电脑或手机登陆 **`管理员帐号`**，并对 **`BOT帐号`**私聊发送：
54+
55+
```shell
56+
/whosyourdaddy
57+
```
58+
59+
BOT将会回复你：
60+
61+
```text
62+
成功 - 您已成为bot管理员
63+
```
64+
65+
如果你没有收到回复，检查是否一直保持DDBOT处于运行状态。
66+
67+
如果仍无法解决，请点击页面右上角的需要帮助。
68+
69+
## 配置DDBOT
70+
71+
TODO

‎docs/guide/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# 命令指南
22

3-
## 下载DDBOT
4-
5-
## 配置DDBOT
3+
## TODO

‎docs/template/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
## 模板介绍
44

5-
???
5+
## TODO

‎package.json

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
"author": "sora233",
66
"license": "CC-BY-SA-4.0",
77
"devDependencies": {
8+
"@vuepress/plugin-active-header-links": "^1.9.7",
9+
"@vuepress/plugin-back-to-top": "^1.9.7",
10+
"@vuepress/plugin-medium-zoom": "^1.9.7",
11+
"@vuepress/plugin-nprogress": "^1.9.7",
812
"vuepress": "^1.9.7"
913
},
1014
"scripts": {

‎yarn.lock

+23-2
Original file line numberDiff line numberDiff line change
@@ -1349,14 +1349,22 @@
13491349
markdown-it-table-of-contents "^0.4.0"
13501350
prismjs "^1.13.0"
13511351

1352-
"@vuepress/[email protected]":
1352+
"@vuepress/[email protected]", "@vuepress/plugin-active-header-links@^1.9.7":
13531353
version "1.9.7"
13541354
resolved "https://registry.npmmirror.com/@vuepress/plugin-active-header-links/-/plugin-active-header-links-1.9.7.tgz#11b3b148d50ebd0a9a9d9e97aa34d81ae04e7307"
13551355
integrity sha512-G1M8zuV9Og3z8WBiKkWrofG44NEXsHttc1MYreDXfeWh/NLjr9q1GPCEXtiCjrjnHZHB3cSQTKnTqAHDq35PGA==
13561356
dependencies:
13571357
"@vuepress/types" "1.9.7"
13581358
lodash.debounce "^4.0.8"
13591359

1360+
"@vuepress/plugin-back-to-top@^1.9.7":
1361+
version "1.9.7"
1362+
resolved "https://registry.npmmirror.com/@vuepress/plugin-back-to-top/-/plugin-back-to-top-1.9.7.tgz#249a76d79f1e0c8c71a2804485ad0245837e6bfd"
1363+
integrity sha512-DM1S+Q8Xn/i+zhe4zThekxb1M2abfKLklg/NKtQloklHKdNdVfk+EcxWYNmNfSii+ymDWaaG8lmH0xjVhy0iXw==
1364+
dependencies:
1365+
"@vuepress/types" "1.9.7"
1366+
lodash.debounce "^4.0.8"
1367+
13601368
"@vuepress/[email protected]":
13611369
version "1.9.7"
13621370
resolved "https://registry.npmmirror.com/@vuepress/plugin-last-updated/-/plugin-last-updated-1.9.7.tgz#9f2d78fe7ced618d0480bf40a3e32b40486bac6d"
@@ -1365,7 +1373,15 @@
13651373
"@vuepress/types" "1.9.7"
13661374
cross-spawn "^6.0.5"
13671375

1368-
"@vuepress/[email protected]":
1376+
"@vuepress/plugin-medium-zoom@^1.9.7":
1377+
version "1.9.7"
1378+
resolved "https://registry.npmmirror.com/@vuepress/plugin-medium-zoom/-/plugin-medium-zoom-1.9.7.tgz#077330aafd23e2cc8372e0041589875345edb80a"
1379+
integrity sha512-P00chXEEoFyQyDWiiSw1mUIdywS6vqM9jolM/3Gv3/TywqemWEm1MKMM7mLsjGiaXJbBQZE+U3/lHmzcaroYLQ==
1380+
dependencies:
1381+
"@vuepress/types" "1.9.7"
1382+
medium-zoom "^1.0.4"
1383+
1384+
"@vuepress/[email protected]", "@vuepress/plugin-nprogress@^1.9.7":
13691385
version "1.9.7"
13701386
resolved "https://registry.npmmirror.com/@vuepress/plugin-nprogress/-/plugin-nprogress-1.9.7.tgz#76d8368fa26c190ee23c399401a71ec78ffb9744"
13711387
integrity sha512-sI148igbdRfLgyzB8PdhbF51hNyCDYXsBn8bBWiHdzcHBx974sVNFKtfwdIZcSFsNrEcg6zo8YIrQ+CO5vlUhQ==
@@ -5331,6 +5347,11 @@ [email protected]:
53315347
resolved "https://registry.npmmirror.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
53325348
integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==
53335349

5350+
medium-zoom@^1.0.4:
5351+
version "1.0.6"
5352+
resolved "https://registry.npmmirror.com/medium-zoom/-/medium-zoom-1.0.6.tgz#9247f21ca9313d8bbe9420aca153a410df08d027"
5353+
integrity sha512-UdiUWfvz9fZMg1pzf4dcuqA0W079o0mpqbTnOz5ip4VGYX96QjmbM+OgOU/0uOzAytxC0Ny4z+VcYQnhdifimg==
5354+
53345355
memory-fs@^0.4.1:
53355356
version "0.4.1"
53365357
resolved "https://registry.npmmirror.com/memory-fs/-/memory-fs-0.4.1.tgz#3a9a20b8462523e447cfbc7e8bb80ed667bfc552"

0 commit comments

Comments
 (0)