From 50941f52593c0066ab27f097cce38e8774be51b0 Mon Sep 17 00:00:00 2001 From: worldmozara <37037264+NCBM@users.noreply.github.com> Date: Mon, 12 Jun 2023 20:39:28 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E5=BE=AE=E8=B0=83=E6=8F=92?= =?UTF-8?q?=E4=BB=B6=E5=85=83=E6=95=B0=E6=8D=AE=E7=9A=84=E9=83=A8=E5=88=86?= =?UTF-8?q?=E6=8F=8F=E8=BF=B0=20(#2096)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/docs/advanced/plugin-info.md | 5 +++-- website/docs/developer/plugin-publishing.mdx | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/website/docs/advanced/plugin-info.md b/website/docs/advanced/plugin-info.md index ca84f91f..ecd6d272 100644 --- a/website/docs/advanced/plugin-info.md +++ b/website/docs/advanced/plugin-info.md @@ -31,7 +31,7 @@ NoneBot 是一个插件化的框架,可以通过加载插件来扩展功能。 我们需要在插件顶层模块 `example/__init__.py` 中添加插件元数据,如下所示: -```python {1,5-11} title=example/__init__.py +```python {1,5-12} title=example/__init__.py from nonebot.plugin import PluginMetadata from .config import Config @@ -40,12 +40,13 @@ __plugin_meta__ = PluginMetadata( name="示例插件", description="这是一个示例插件", usage="没什么用", + type="application", config=Config, extra={}, ) ``` -我们可以看到,插件元数据 `PluginMetadata` 有三个基本属性:插件名称、插件描述、插件使用方法。除此之外,还有几个可选的属性: +我们可以看到,插件元数据 `PluginMetadata` 有三个基本属性:插件名称、插件描述、插件使用方法。除此之外,还有几个可选的属性(具体填写见[发布插件](../developer/plugin-publishing.mdx#填写插件元数据)章节): - `type`:插件类别,发布插件必填。当前有效类别有:`library`(为其他插件编写提供功能),`application`(向机器人用户提供功能); - `homepage`:插件项目主页,发布插件必填; diff --git a/website/docs/developer/plugin-publishing.mdx b/website/docs/developer/plugin-publishing.mdx index ea381c78..0920b22a 100644 --- a/website/docs/developer/plugin-publishing.mdx +++ b/website/docs/developer/plugin-publishing.mdx @@ -96,7 +96,7 @@ __plugin_meta__ = PluginMetadata( config=Config, # 插件配置项类,如无需配置可不填写。 - supported_adapters={"~onebot.v11"}, + supported_adapters={"~onebot.v11", "~telegram"}, # 支持的适配器集合,其中 `~` 在此处代表前缀 `nonebot.adapters.`,其余适配器亦按此格式填写。 # 若插件可以保证兼容所有适配器(即仅使用基本适配器功能)可不填写,否则应该列出插件支持的适配器。 )