diff --git a/.vitepress/config/zh-CN.json b/.vitepress/config/zh-CN.json index 37c6427d4aa2..e2aa964730f8 100644 --- a/.vitepress/config/zh-CN.json +++ b/.vitepress/config/zh-CN.json @@ -529,6 +529,9 @@ }, { "text": "WhatsApp", "link": "/plugins/adapter/whatsapp.md" + }, { + "text": "Zulip", + "link": "/plugins/adapter/zulip.md" }] }, { "text": "数据库支持", diff --git a/zh-CN/plugins/adapter/zulip.md b/zh-CN/plugins/adapter/zulip.md new file mode 100644 index 000000000000..129dcfd1f088 --- /dev/null +++ b/zh-CN/plugins/adapter/zulip.md @@ -0,0 +1,22 @@ +# @koishijs/plugin-adapter-zulip + +## 接入指南 + +1. 登录自己的 Zulip 社群,右上角设置按钮选择「个人设置」,在弹窗左侧进入「机器人」,点击「新增机器人」输入相关信息后点击新增。 +2. 在界面中找到新创建的机器人,复制机器人邮箱填入插件的 `email` 字段,复制 API KEY 填入插件的 `key` 字段。 + +## 配置项 + +### config.email + +- 类型: `string` +- 必需字段 + +机器人邮箱。 + +### config.key + +- 类型: `string` +- 必需字段 + +机器人 API 密钥。