From 400ae0efc4df445d04e16ea554b6b0c1133563ea Mon Sep 17 00:00:00 2001 From: Shigma Date: Tue, 8 Aug 2023 13:15:18 +0800 Subject: [PATCH] update online guide --- package.json | 6 +++--- zh-CN/cookbook/online.md | 34 ++++++++++++++++----------------- zh-CN/cookbook/testing.md | 21 +++++++++----------- zh-CN/guide/console/index.md | 20 +++++++++---------- zh-CN/manual/console/adapter.md | 14 +++++++------- zh-CN/plugins/adapter/line.md | 10 +++++----- 6 files changed, 50 insertions(+), 55 deletions(-) diff --git a/package.json b/package.json index df48f9123251..3a7a8b1e7670 100644 --- a/package.json +++ b/package.json @@ -11,15 +11,15 @@ }, "devDependencies": { "@koishijs/components": "^1.3.3", - "@koishijs/core": "^4.14.0", + "@koishijs/core": "^4.14.1", "@koishijs/market": "^4.1.2", "@koishijs/registry": "^6.0.2", - "@koishijs/vitepress": "^2.2.1", + "@koishijs/vitepress": "^2.2.2", "@types/node": "^20.4.2", "@types/spark-md5": "^3.0.2", "cross-env": "^7.0.3", "element-plus": "2.3.8", - "koishi": "^4.14.0", + "koishi": "^4.14.1", "marked-vue": "^1.2.3", "typescript": "^5.1.6", "vitepress": "1.0.0-alpha.73", diff --git a/zh-CN/cookbook/online.md b/zh-CN/cookbook/online.md index aa55a66209a9..d34603df7e59 100644 --- a/zh-CN/cookbook/online.md +++ b/zh-CN/cookbook/online.md @@ -56,22 +56,20 @@ export const Config = Schema.object({ ### 独立入口 -你可以选择让插件为普通的 Koishi 实例和 k-on! 实例提供不同的入口文件。首先修改目录结构： - -```diff -root -└── external - └── example - ├── src -+ │ ├── node -+ │ │ └── index.ts -+ │ ├── browser -+ │ │ └── index.ts -+ │ ├── shared -+ │ │ └── index.ts - │ └── index.ts - ├── package.json - └── tsconfig.json +你可以选择让插件为普通的 Koishi 实例和 k-on! 实例提供不同的入口文件。首先修改插件的目录结构： + +```diff{3-8} +└── example + ├── src ++ │ ├── node ++ │ │ └── index.ts ++ │ ├── browser ++ │ │ └── index.ts ++ │ ├── shared ++ │ │ └── index.ts + │ └── index.ts + ├── package.json + └── tsconfig.json ``` 这里，`node` 目录存放 Node.js 环境下的入口文件，`browser` 目录存放浏览器环境下的入口文件，`shared` 目录存放一些两者共用的代码。原本的 `index.ts` 可以改成这样： @@ -170,14 +168,16 @@ ctx.console.addEntry(process.env.KOISHI_BASE ? [ 如果你想在本地测试插件是否能在 k-on! 中运行，可以参考以下流程： -1. 克隆 koishijs/webui 仓库。 +1. 克隆 koishijs/webui 和 koishijs/ponyfills 仓库。 ::: tabs code ```npm npm run clone koishijs/webui +npm run clone koishijs/ponyfills ``` ```yarn yarn clone koishijs/webui +yarn clone koishijs/ponyfills ``` ::: diff --git a/zh-CN/cookbook/testing.md b/zh-CN/cookbook/testing.md index a05c5ff69e58..ff1e09c2fce8 100644 --- a/zh-CN/cookbook/testing.md +++ b/zh-CN/cookbook/testing.md @@ -31,18 +31,15 @@ yarn add mocha chai @koishijs/plugin-mock @types/mocha @types/chai -DW 这里的 `-W` 表明直接安装到根工作区。你也可以改成只对一个插件添加这些依赖，不过考虑到你可能会在其他插件中也用到它们，安装到根工作区会更加方便。 ::: -接着创建存放测试文件的 `tests` 目录，并在其中新建一个 `index.spec.ts` 文件： - -```diff{6-7} -root -├── external -│ └── example -│ ├── src -│ │ └── index.ts -│ ├── tests -│ │ └── index.spec.ts -│ └── package.json -└── package.json +接着在插件目录中创建存放测试文件的 `tests` 目录，并在其中新建 `index.spec.ts` 文件： + +```diff +└── example + ├── src + │ └── index.ts ++ ├── tests ++ │ └── index.spec.ts + └── package.json ``` 这个文件将用于编写测试代码： diff --git a/zh-CN/guide/console/index.md b/zh-CN/guide/console/index.md index 945716ac6047..7983d7ee6391 100644 --- a/zh-CN/guide/console/index.md +++ b/zh-CN/guide/console/index.md @@ -9,17 +9,15 @@ 在插件目录中新建这几个文件： ```diff -root -└── external - └── example -+ ├── client -+ │ ├── index.ts -+ │ ├── page.vue -+ │ └── tsconfig.json - ├── src - │ └── index.ts - ├── package.json - └── tsconfig.json +└── example ++ ├── client ++ │ ├── index.ts ++ │ ├── page.vue ++ │ └── tsconfig.json + ├── src + │ └── index.ts + ├── package.json + └── tsconfig.json ``` ```ts title=client/index.ts no-extra-header diff --git a/zh-CN/manual/console/adapter.md b/zh-CN/manual/console/adapter.md index c590df70f5f5..efe838c720e7 100644 --- a/zh-CN/manual/console/adapter.md +++ b/zh-CN/manual/console/adapter.md @@ -38,11 +38,11 @@ Koishi 使用适配器插件来支持各种聊天平台。其中，常用的适 ## LINE -1. 在 [LINE 开发者控制台](https://developers.line.biz/console/) 注册账号，创建一个新的 Provider，在 Provider 中创建一个 Channel，类型选择 Messaging API，输入相关信息。 -2. 在 Basic settings 页面找到 Channel secret，填入插件的 secret 字段。 -3. 在 Messaging API 页面底部 Channel access token 处点击 Issue 创建 token，填入插件的 token 字段。 -4. 根据使用需求可在上方的 Allow bot to join group chats (允许机器人加入群组) 处点击 Edit，在新页面中找到 Toggle features 一栏，第一对单选框选择 Allow。 -5. 在 Messaging API 页面底部，根据使用需求点击 Auto-reply messages 或者 Greeting messages 的修改按钮，在新页面中可设置是否启用平台自带的自动回复或问候消息。 +1. 在 [LINE 开发者控制台](https://developers.line.biz/console/) 注册账号，创建一个新的 Provider，在 Provider 中创建一个 Channel，类型选择 Messaging API，输入相关信息 +2. 在 Basic settings 页面找到 Channel secret，填入插件的 secret 字段 +3. 在 Messaging API 页面底部 Channel access token 处点击 Issue 创建 token，填入插件的 token 字段 +4. 根据使用需求可在上方的 Allow bot to join group chats (允许机器人加入群组) 处点击 Edit，在新页面中找到 Toggle features 一栏，第一对单选框选择 Allow +5. 在 Messaging API 页面底部，根据使用需求点击 Auto-reply messages 或者 Greeting messages 的修改按钮，在新页面中可设置是否启用平台自带的自动回复或问候消息 6. 在 Security 页面推荐配置白名单 IP 7. 启动插件，打开 Messaging API 页面，勾选 Use webhook @@ -50,8 +50,8 @@ Koishi 使用适配器插件来支持各种聊天平台。其中，常用的适 ## 邮件 -1. 「username」对应你的邮箱账号，「password」对应你的授权码 -2. 「imap」对应接收邮件服务器，「smtp」对应发送邮件服务器，需要分别填写对应的「host」和「port」 +1. `username` 对应你的邮箱账号，`password` 对应你的授权码 +2. `imap` 对应接收邮件服务器，`smtp` 对应发送邮件服务器，需要分别填写对应的 `host` 和 `port` 3. 不同邮箱服务获取授权码的方式也有所不同，可以参考下面的主流邮件服务进行配置 参考：[@koishijs/plugin-adapter-mail](../../plugins/adapter/mail.md) diff --git a/zh-CN/plugins/adapter/line.md b/zh-CN/plugins/adapter/line.md index 10c29f81f425..8374ea3231e4 100644 --- a/zh-CN/plugins/adapter/line.md +++ b/zh-CN/plugins/adapter/line.md @@ -2,11 +2,11 @@ ## 接入方法 -1. 在 [LINE 开发者控制台](https://developers.line.biz/console/) 注册账号，创建一个新的 Provider，在 Provider 中创建一个 Channel，类型选择 Messaging API，输入相关信息。 -2. 在 Basic settings 页面找到 Channel secret，填入插件的 secret 字段。 -3. 在 Messaging API 页面底部 Channel access token 处点击 Issue 创建 token，填入插件的 token 字段。 -4. 根据使用需求可在上方的 Allow bot to join group chats (允许机器人加入群组) 处点击 Edit，在新页面中找到 Toggle features 一栏，第一对单选框选择 Allow。 -5. 在 Messaging API 页面底部，根据使用需求点击 Auto-reply messages 或者 Greeting messages 的修改按钮，在新页面中可设置是否启用平台自带的自动回复或问候消息。 +1. 在 [LINE 开发者控制台](https://developers.line.biz/console/) 注册账号，创建一个新的 Provider，在 Provider 中创建一个 Channel，类型选择 Messaging API，输入相关信息 +2. 在 Basic settings 页面找到 Channel secret，填入插件的 secret 字段 +3. 在 Messaging API 页面底部 Channel access token 处点击 Issue 创建 token，填入插件的 token 字段 +4. 根据使用需求可在上方的 Allow bot to join group chats (允许机器人加入群组) 处点击 Edit，在新页面中找到 Toggle features 一栏，第一对单选框选择 Allow +5. 在 Messaging API 页面底部，根据使用需求点击 Auto-reply messages 或者 Greeting messages 的修改按钮，在新页面中可设置是否启用平台自带的自动回复或问候消息 6. 在 Security 页面推荐配置白名单 IP 7. 启动插件，打开 Messaging API 页面，勾选 Use webhook