From 3454c716a976f2cba5df59ebcdb5533df785732a Mon Sep 17 00:00:00 2001 From: Xfjie314 <2075553664@qq.com> Date: Tue, 11 Nov 2025 00:17:16 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E4=BF=AE=E5=A4=8D=E6=8F=92?= =?UTF-8?q?=E4=BB=B6=E7=BC=96=E5=86=99=E5=87=86=E5=A4=87=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=B8=AD=E7=9A=84=E6=96=87=E6=9C=AC=E9=94=99=E8=AF=AF=20(#3746?= =?UTF-8?q?)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> --- website/docs/tutorial/create-plugin.md | 8 ++++++-- .../version-2.4.2/tutorial/create-plugin.md | 16 ++++++++++++---- .../version-2.4.3/tutorial/create-plugin.md | 16 ++++++++++++---- .../version-2.4.4/tutorial/create-plugin.md | 8 ++++++-- 4 files changed, 36 insertions(+), 12 deletions(-) diff --git a/website/docs/tutorial/create-plugin.md b/website/docs/tutorial/create-plugin.md index 51a56faa..2f9b4fee 100644 --- a/website/docs/tutorial/create-plugin.md +++ b/website/docs/tutorial/create-plugin.md @@ -48,8 +48,10 @@ options: ```tree title=Project ๐Ÿ“ฆ awesome-bot + โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins + โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` @@ -91,18 +93,20 @@ options: $ nb plugin create [?] ๆ’ไปถๅ็งฐ: weather [?] ไฝฟ็”จๅตŒๅฅ—ๆ’ไปถ? (y/N) N -[?] ่พ“ๅ‡บ็›ฎๅฝ•: awesome_bot/plugins +[?] ่ฏท่พ“ๅ…ฅๆ’ไปถๅญ˜ๅ‚จไฝ็ฝฎ: awesome_bot/plugins ``` `nb-cli` ไผšๅœจ `awesome_bot/plugins` ็›ฎๅฝ•ไธ‹ๅˆ›ๅปบไธ€ไธชๅไธบ `weather` ็š„ๆ–‡ไปถๅคน๏ผŒๅ…ถไธญๅŒ…ๅซ็š„ๆ–‡ไปถๅฐ†ๅœจ็จๅŽ็ซ ่Š‚ไธญ็”จๅˆฐใ€‚ ```tree title=Project ๐Ÿ“ฆ awesome-bot +โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins -| โ””โ”€โ”€ ๐Ÿ“‚ foo +| โ””โ”€โ”€ ๐Ÿ“‚ weather | โ”œโ”€โ”€ ๐Ÿ“œ __init__.py | โ””โ”€โ”€ ๐Ÿ“œ config.py +โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` diff --git a/website/versioned_docs/version-2.4.2/tutorial/create-plugin.md b/website/versioned_docs/version-2.4.2/tutorial/create-plugin.md index 9ce4ed4d..135fbe30 100644 --- a/website/versioned_docs/version-2.4.2/tutorial/create-plugin.md +++ b/website/versioned_docs/version-2.4.2/tutorial/create-plugin.md @@ -48,8 +48,10 @@ options: ```tree title=Project ๐Ÿ“ฆ awesome-bot + โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins + โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` @@ -91,18 +93,20 @@ options: $ nb plugin create [?] ๆ’ไปถๅ็งฐ: weather [?] ไฝฟ็”จๅตŒๅฅ—ๆ’ไปถ? (y/N) N -[?] ่พ“ๅ‡บ็›ฎๅฝ•: awesome_bot/plugins +[?] ่ฏท่พ“ๅ…ฅๆ’ไปถๅญ˜ๅ‚จไฝ็ฝฎ: awesome_bot/plugins ``` `nb-cli` ไผšๅœจ `awesome_bot/plugins` ็›ฎๅฝ•ไธ‹ๅˆ›ๅปบไธ€ไธชๅไธบ `weather` ็š„ๆ–‡ไปถๅคน๏ผŒๅ…ถไธญๅŒ…ๅซ็š„ๆ–‡ไปถๅฐ†ๅœจ็จๅŽ็ซ ่Š‚ไธญ็”จๅˆฐใ€‚ ```tree title=Project ๐Ÿ“ฆ awesome-bot +โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins -| โ””โ”€โ”€ ๐Ÿ“‚ foo +| โ””โ”€โ”€ ๐Ÿ“‚ weather | โ”œโ”€โ”€ ๐Ÿ“œ __init__.py | โ””โ”€โ”€ ๐Ÿ“œ config.py +โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` @@ -189,12 +193,16 @@ nonebot.load_from_json("plugin_config.json", encoding="utf-8") ### `load_from_toml` -้€š่ฟ‡ TOML ๆ–‡ไปถๅŠ ่ฝฝๆ’ไปถ๏ผŒๆ˜ฏ [`load_all_plugins`](#load_all_plugins) ็š„ TOML ๅ˜็งใ€‚้€š่ฟ‡่ฏปๅ– TOML ๆ–‡ไปถไธญ็š„ `[tool.nonebot]` Table ไธญ็š„ `plugins` ๅ’Œ `plugin_dirs` Array ่ฟ›่กŒๅŠ ่ฝฝใ€‚ไพ‹ๅฆ‚๏ผš +้€š่ฟ‡ TOML ๆ–‡ไปถๅŠ ่ฝฝๆ’ไปถ๏ผŒๆ˜ฏ [`load_all_plugins`](#load_all_plugins) ็š„ TOML ๅ˜็งใ€‚้€š่ฟ‡่ฏปๅ– TOML ๆ–‡ไปถไธญ็š„ `[tool.nonebot]` Table ไธญ็š„ `plugin_dirs` Array ไธŽ +`[tool.nonebot.plugins]` Table ไธญ็š„ๅคšไธช Array ่ฟ›่กŒๅŠ ่ฝฝใ€‚ไพ‹ๅฆ‚๏ผš ```toml title=plugin_config.toml [tool.nonebot] -plugins = ["path.to.your.plugin"] plugin_dirs = ["path/to/your/plugins"] + +[tool.nonebot.plugins] +"@local" = ["path.to.your.plugin"] # ๆœฌๅœฐๆ’ไปถ็ญ‰้žๆ’ไปถๅ•†ๅบ—ๆฅๆบ็š„ๆ’ไปถ +"nonebot-plugin-someplugin" = ["nonebot_plugin_someplugin"] # ๆ’ไปถๅ•†ๅบ—ๆฅๆบ็š„ๆ’ไปถ ``` ```python diff --git a/website/versioned_docs/version-2.4.3/tutorial/create-plugin.md b/website/versioned_docs/version-2.4.3/tutorial/create-plugin.md index 9ce4ed4d..135fbe30 100644 --- a/website/versioned_docs/version-2.4.3/tutorial/create-plugin.md +++ b/website/versioned_docs/version-2.4.3/tutorial/create-plugin.md @@ -48,8 +48,10 @@ options: ```tree title=Project ๐Ÿ“ฆ awesome-bot + โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins + โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` @@ -91,18 +93,20 @@ options: $ nb plugin create [?] ๆ’ไปถๅ็งฐ: weather [?] ไฝฟ็”จๅตŒๅฅ—ๆ’ไปถ? (y/N) N -[?] ่พ“ๅ‡บ็›ฎๅฝ•: awesome_bot/plugins +[?] ่ฏท่พ“ๅ…ฅๆ’ไปถๅญ˜ๅ‚จไฝ็ฝฎ: awesome_bot/plugins ``` `nb-cli` ไผšๅœจ `awesome_bot/plugins` ็›ฎๅฝ•ไธ‹ๅˆ›ๅปบไธ€ไธชๅไธบ `weather` ็š„ๆ–‡ไปถๅคน๏ผŒๅ…ถไธญๅŒ…ๅซ็š„ๆ–‡ไปถๅฐ†ๅœจ็จๅŽ็ซ ่Š‚ไธญ็”จๅˆฐใ€‚ ```tree title=Project ๐Ÿ“ฆ awesome-bot +โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins -| โ””โ”€โ”€ ๐Ÿ“‚ foo +| โ””โ”€โ”€ ๐Ÿ“‚ weather | โ”œโ”€โ”€ ๐Ÿ“œ __init__.py | โ””โ”€โ”€ ๐Ÿ“œ config.py +โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` @@ -189,12 +193,16 @@ nonebot.load_from_json("plugin_config.json", encoding="utf-8") ### `load_from_toml` -้€š่ฟ‡ TOML ๆ–‡ไปถๅŠ ่ฝฝๆ’ไปถ๏ผŒๆ˜ฏ [`load_all_plugins`](#load_all_plugins) ็š„ TOML ๅ˜็งใ€‚้€š่ฟ‡่ฏปๅ– TOML ๆ–‡ไปถไธญ็š„ `[tool.nonebot]` Table ไธญ็š„ `plugins` ๅ’Œ `plugin_dirs` Array ่ฟ›่กŒๅŠ ่ฝฝใ€‚ไพ‹ๅฆ‚๏ผš +้€š่ฟ‡ TOML ๆ–‡ไปถๅŠ ่ฝฝๆ’ไปถ๏ผŒๆ˜ฏ [`load_all_plugins`](#load_all_plugins) ็š„ TOML ๅ˜็งใ€‚้€š่ฟ‡่ฏปๅ– TOML ๆ–‡ไปถไธญ็š„ `[tool.nonebot]` Table ไธญ็š„ `plugin_dirs` Array ไธŽ +`[tool.nonebot.plugins]` Table ไธญ็š„ๅคšไธช Array ่ฟ›่กŒๅŠ ่ฝฝใ€‚ไพ‹ๅฆ‚๏ผš ```toml title=plugin_config.toml [tool.nonebot] -plugins = ["path.to.your.plugin"] plugin_dirs = ["path/to/your/plugins"] + +[tool.nonebot.plugins] +"@local" = ["path.to.your.plugin"] # ๆœฌๅœฐๆ’ไปถ็ญ‰้žๆ’ไปถๅ•†ๅบ—ๆฅๆบ็š„ๆ’ไปถ +"nonebot-plugin-someplugin" = ["nonebot_plugin_someplugin"] # ๆ’ไปถๅ•†ๅบ—ๆฅๆบ็š„ๆ’ไปถ ``` ```python diff --git a/website/versioned_docs/version-2.4.4/tutorial/create-plugin.md b/website/versioned_docs/version-2.4.4/tutorial/create-plugin.md index 51a56faa..2f9b4fee 100644 --- a/website/versioned_docs/version-2.4.4/tutorial/create-plugin.md +++ b/website/versioned_docs/version-2.4.4/tutorial/create-plugin.md @@ -48,8 +48,10 @@ options: ```tree title=Project ๐Ÿ“ฆ awesome-bot + โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins + โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ``` @@ -91,18 +93,20 @@ options: $ nb plugin create [?] ๆ’ไปถๅ็งฐ: weather [?] ไฝฟ็”จๅตŒๅฅ—ๆ’ไปถ? (y/N) N -[?] ่พ“ๅ‡บ็›ฎๅฝ•: awesome_bot/plugins +[?] ่ฏท่พ“ๅ…ฅๆ’ไปถๅญ˜ๅ‚จไฝ็ฝฎ: awesome_bot/plugins ``` `nb-cli` ไผšๅœจ `awesome_bot/plugins` ็›ฎๅฝ•ไธ‹ๅˆ›ๅปบไธ€ไธชๅไธบ `weather` ็š„ๆ–‡ไปถๅคน๏ผŒๅ…ถไธญๅŒ…ๅซ็š„ๆ–‡ไปถๅฐ†ๅœจ็จๅŽ็ซ ่Š‚ไธญ็”จๅˆฐใ€‚ ```tree title=Project ๐Ÿ“ฆ awesome-bot +โ”œโ”€โ”€ ๐Ÿ“‚ .venv โ”œโ”€โ”€ ๐Ÿ“‚ awesome_bot โ”‚ โ””โ”€โ”€ ๐Ÿ“‚ plugins -| โ””โ”€โ”€ ๐Ÿ“‚ foo +| โ””โ”€โ”€ ๐Ÿ“‚ weather | โ”œโ”€โ”€ ๐Ÿ“œ __init__.py | โ””โ”€โ”€ ๐Ÿ“œ config.py +โ”œโ”€โ”€ ๐Ÿ“œ .env.prod โ”œโ”€โ”€ ๐Ÿ“œ pyproject.toml โ””โ”€โ”€ ๐Ÿ“œ README.md ```