From 7af5f6c408c6cb3b2881d7b47b492fdb7cedf7ca Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Fri, 8 Nov 2024 23:07:17 +0800 Subject: [PATCH] =?UTF-8?q?doc:=20=E4=BC=98=E5=8C=96api=E5=8F=82=E8=80=83?= =?UTF-8?q?=E9=A1=B5=E7=9A=84=E5=86=85=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.mts | 12 ++++++------ docs/{develop => plugin}/api-ref.md | 4 +++- docs/{develop => plugin}/extension.md | 0 docs/{develop => plugin}/plugin-dev.md | 0 docs/{develop => plugin}/plugin-intro.md | 0 docs/{develop => plugin}/tech-info.md | 0 6 files changed, 9 insertions(+), 7 deletions(-) rename docs/{develop => plugin}/api-ref.md (85%) rename docs/{develop => plugin}/extension.md (100%) rename docs/{develop => plugin}/plugin-dev.md (100%) rename docs/{develop => plugin}/plugin-intro.md (100%) rename docs/{develop => plugin}/tech-info.md (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 290f3a846..06ec96aa4 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -124,14 +124,14 @@ export default defineConfig({ ], }, { - text: "开发", + text: "插件", // collapsed: true, items: [ - { text: "插件介绍", link: "/develop/plugin-intro" }, - { text: "插件开发", link: "/develop/plugin-dev" }, - { text: "组件拓展", link: "/develop/extension" }, - { text: "API参考", link: "/develop/api-ref" }, - { text: "技术信息", link: "/develop/tech-info" }, + { text: "插件介绍", link: "/plugin/plugin-intro" }, + { text: "插件开发", link: "/plugin/plugin-dev" }, + { text: "组件拓展", link: "/plugin/extension" }, + { text: "API参考", link: "/plugin/api-ref" }, + { text: "技术信息", link: "/plugin/tech-info" }, ], }, // { diff --git a/docs/develop/api-ref.md b/docs/plugin/api-ref.md similarity index 85% rename from docs/develop/api-ref.md rename to docs/plugin/api-ref.md index 76d33f482..95ed8b3d2 100644 --- a/docs/develop/api-ref.md +++ b/docs/plugin/api-ref.md @@ -28,6 +28,8 @@ ctx.send_message(target_type: str, target_id: str, message_chain: mirai.MessageC - `target_id`:目标 ID(QQ 号或群号) - `message_chain`:[YiriMirai 的 MessageChain 对象](https://yiri-mirai.wybxc.cc/docs/basic/message-chain),若用户使用的不是 YiriMirai 适配器,程序也能自动转换为目标消息链 +## 事件处理 + ### 阻止事件默认行为 ```python @@ -50,4 +52,4 @@ ctx.prevent_postorder() ctx.add_return(name: str, value: Any) ``` -添加返回值,返回值可在事件监听器中通过`ctx.returns[name]`访问。事件返回值均为**可选**的,每个事件支持的返回值请查看`pkg.plugin.events`中的每个事件的注释。 +添加返回值,事件返回值均为**可选**的,每个事件支持的返回值请查看`pkg.plugin.events`中的每个事件的注释。 diff --git a/docs/develop/extension.md b/docs/plugin/extension.md similarity index 100% rename from docs/develop/extension.md rename to docs/plugin/extension.md diff --git a/docs/develop/plugin-dev.md b/docs/plugin/plugin-dev.md similarity index 100% rename from docs/develop/plugin-dev.md rename to docs/plugin/plugin-dev.md diff --git a/docs/develop/plugin-intro.md b/docs/plugin/plugin-intro.md similarity index 100% rename from docs/develop/plugin-intro.md rename to docs/plugin/plugin-intro.md diff --git a/docs/develop/tech-info.md b/docs/plugin/tech-info.md similarity index 100% rename from docs/develop/tech-info.md rename to docs/plugin/tech-info.md