diff --git a/archive/2.0.0a16/advanced/publish-plugin.md b/archive/2.0.0a16/advanced/publish-plugin.md index d34806d2..7fdfa706 100644 --- a/archive/2.0.0a16/advanced/publish-plugin.md +++ b/archive/2.0.0a16/advanced/publish-plugin.md @@ -8,42 +8,42 @@ ### 发布到 PyPI -您可以选择任意自己喜欢的方式将您的插件发布到 **[PyPI](https://pypi.org/)** ，如使用 **[setuptools](https://pypi.org/project/setuptools/)** 或 **[poetry](https://pypi.org/project/poetry/)** 进行PyPI发布。 +您可以选择任意自己喜欢的方式将您的插件发布到 **[PyPI](https://pypi.org/)** ，如使用 **[setuptools](https://pypi.org/project/setuptools/)** 或 **[poetry](https://pypi.org/project/poetry/)** 进行 PyPI 发布。 -发布时，请您为自己的插件取一个清晰易懂的名字。通常而言，一款 NoneBot2 插件名称使用 *nonebot-plugin-* 作为前缀(如`nonebot-plugin-foo`)，以 *nonebot_plugin_* 作为导入名的前缀(如`nonebot_plugin_foo`)，这并非是强制规范, 而是为了防止与其他PyPI包产生冲突, 所以我们推荐您在没有特殊需求的情况下这样做。 +发布时，请您为自己的插件取一个清晰易懂的名字。通常而言，一款 NoneBot2 插件名称使用 _nonebot-plugin-_ 作为前缀(如`nonebot-plugin-foo`)，以 _nonebot*plugin*_ 作为导入名的前缀(如`nonebot_plugin_foo`)，这并非是强制规范, 而是为了防止与其他 PyPI 包产生冲突, 所以我们推荐您在没有特殊需求的情况下这样做。 -发布后，请确保您的插件已能公开的从 PyPI 访问到，请检查您的插件在PyPI的地址：`https://pypi.org/project/<您的Nonebot2插件项目名>` +发布后，请确保您的插件已能公开的从 PyPI 访问到，请检查您的插件在 PyPI 的地址：`https://pypi.org/project/<您的Nonebot2插件项目名>` ### 托管您的插件源代码 -将插件源代码及相关构建文件（如`pyproject.toml`或`setup.py`等与PyPI包构建相关的文件）托管在公开代码仓。 +将插件源代码及相关构建文件（如`pyproject.toml`或`setup.py`等与 PyPI 包构建相关的文件）托管在公开代码仓。 请确保您的代码仓地址能够被正确的访问，检查您的插件在代码仓的地址，如 `https://github.com/<您的Github用户名>/<您的插件Github项目名>` 。 -### 申请发布到Nonebot2插件商店 +### 申请发布到 Nonebot2 插件商店 -完成在 PyPI 的插件发布流程与源代码托管流程后，请您前往 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** 页面，切换到插件页签，点击 **发布插件** 按钮。 +完成在 PyPI 的插件发布流程与源代码托管流程后，请您前往 **[NoneBot2 商店](https://v2.nonebot.dev/store.html)** 页面，切换到插件页签，点击 **发布插件** 按钮。 -![插件发布界面](images/plugin_store_publish.png) +![插件发布界面](./images/plugin_store_publish.png) 如图所示，在弹出的插件信息提交表单内，填入您所要发布的相应插件信息。 -![插件信息填写](images/plugin_store_publish_2.png) +![插件信息填写](./images/plugin_store_publish_2.png) -完成填写后，请点击 **发布** 按钮，这将自动在 **[NoneBot2](https://github.com/nonebot/nonebot2)** 代码仓内创建发布您的插件的对应Issue。 +完成填写后，请点击 **发布** 按钮，这将自动在 **[NoneBot2](https://github.com/nonebot/nonebot2)** 代码仓内创建发布您的插件的对应 Issue。 ### 等待插件发布处理 -您的插件发布Issue创建后，将会经过*Nonebot2 Publish Bot*的检查，以确保插件信息正确无误。 +您的插件发布 Issue 创建后，将会经过*Nonebot2 Publish Bot*的检查，以确保插件信息正确无误。 -之后，NoneBot2的维护者们将会对插件进行进一步的检查，以确保用户能够正常安装并使用该插件。 +之后，NoneBot2 的维护者们将会对插件进行进一步的检查，以确保用户能够正常安装并使用该插件。 -完成这些步骤后，您的插件将会被合并到 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** ，而您也将成为 **[NoneBot2贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** 的一员。 +完成这些步骤后，您的插件将会被合并到 **[NoneBot2 商店](https://v2.nonebot.dev/store.html)** ，而您也将成为 **[NoneBot2 贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** 的一员。 ## 完成 -恭喜您，经过上述的发布流程，您的插件已经成功发布到Nonebot2商店了。 +恭喜您，经过上述的发布流程，您的插件已经成功发布到 Nonebot2 商店了。 -此时，您可以在 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** 的插件页签查找到您的插件。同时，欢迎您成为 **[NoneBot2贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** ！ +此时，您可以在 **[NoneBot2 商店](https://v2.nonebot.dev/store.html)** 的插件页签查找到您的插件。同时，欢迎您成为 **[NoneBot2 贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** ！ **Congratulations!** diff --git a/docs/advanced/publish-plugin.md b/docs/advanced/publish-plugin.md index 6ff73cc8..7fdfa706 100644 --- a/docs/advanced/publish-plugin.md +++ b/docs/advanced/publish-plugin.md @@ -8,21 +8,21 @@ ### 发布到 PyPI -您可以选择任意自己喜欢的方式将您的插件发布到 **[PyPI](https://pypi.org/)** ，如使用 **[setuptools](https://pypi.org/project/setuptools/)** 或 **[poetry](https://pypi.org/project/poetry/)** 进行PyPI发布。 +您可以选择任意自己喜欢的方式将您的插件发布到 **[PyPI](https://pypi.org/)** ，如使用 **[setuptools](https://pypi.org/project/setuptools/)** 或 **[poetry](https://pypi.org/project/poetry/)** 进行 PyPI 发布。 -发布时，请您为自己的插件取一个清晰易懂的名字。通常而言，一款 NoneBot2 插件名称使用 *nonebot-plugin-* 作为前缀(如`nonebot-plugin-foo`)，以 *nonebot_plugin_* 作为导入名的前缀(如`nonebot_plugin_foo`)，这并非是强制规范, 而是为了防止与其他PyPI包产生冲突, 所以我们推荐您在没有特殊需求的情况下这样做。 +发布时，请您为自己的插件取一个清晰易懂的名字。通常而言，一款 NoneBot2 插件名称使用 _nonebot-plugin-_ 作为前缀(如`nonebot-plugin-foo`)，以 _nonebot*plugin*_ 作为导入名的前缀(如`nonebot_plugin_foo`)，这并非是强制规范, 而是为了防止与其他 PyPI 包产生冲突, 所以我们推荐您在没有特殊需求的情况下这样做。 -发布后，请确保您的插件已能公开的从 PyPI 访问到，请检查您的插件在PyPI的地址：`https://pypi.org/project/<您的Nonebot2插件项目名>` +发布后，请确保您的插件已能公开的从 PyPI 访问到，请检查您的插件在 PyPI 的地址：`https://pypi.org/project/<您的Nonebot2插件项目名>` ### 托管您的插件源代码 -将插件源代码及相关构建文件（如`pyproject.toml`或`setup.py`等与PyPI包构建相关的文件）托管在公开代码仓。 +将插件源代码及相关构建文件（如`pyproject.toml`或`setup.py`等与 PyPI 包构建相关的文件）托管在公开代码仓。 请确保您的代码仓地址能够被正确的访问，检查您的插件在代码仓的地址，如 `https://github.com/<您的Github用户名>/<您的插件Github项目名>` 。 -### 申请发布到Nonebot2插件商店 +### 申请发布到 Nonebot2 插件商店 -完成在 PyPI 的插件发布流程与源代码托管流程后，请您前往 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** 页面，切换到插件页签，点击 **发布插件** 按钮。 +完成在 PyPI 的插件发布流程与源代码托管流程后，请您前往 **[NoneBot2 商店](https://v2.nonebot.dev/store.html)** 页面，切换到插件页签，点击 **发布插件** 按钮。 ![插件发布界面](./images/plugin_store_publish.png) @@ -30,20 +30,20 @@ ![插件信息填写](./images/plugin_store_publish_2.png) -完成填写后，请点击 **发布** 按钮，这将自动在 **[NoneBot2](https://github.com/nonebot/nonebot2)** 代码仓内创建发布您的插件的对应Issue。 +完成填写后，请点击 **发布** 按钮，这将自动在 **[NoneBot2](https://github.com/nonebot/nonebot2)** 代码仓内创建发布您的插件的对应 Issue。 ### 等待插件发布处理 -您的插件发布Issue创建后，将会经过*Nonebot2 Publish Bot*的检查，以确保插件信息正确无误。 +您的插件发布 Issue 创建后，将会经过*Nonebot2 Publish Bot*的检查，以确保插件信息正确无误。 -之后，NoneBot2的维护者们将会对插件进行进一步的检查，以确保用户能够正常安装并使用该插件。 +之后，NoneBot2 的维护者们将会对插件进行进一步的检查，以确保用户能够正常安装并使用该插件。 -完成这些步骤后，您的插件将会被合并到 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** ，而您也将成为 **[NoneBot2贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** 的一员。 +完成这些步骤后，您的插件将会被合并到 **[NoneBot2 商店](https://v2.nonebot.dev/store.html)** ，而您也将成为 **[NoneBot2 贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** 的一员。 ## 完成 -恭喜您，经过上述的发布流程，您的插件已经成功发布到Nonebot2商店了。 +恭喜您，经过上述的发布流程，您的插件已经成功发布到 Nonebot2 商店了。 -此时，您可以在 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** 的插件页签查找到您的插件。同时，欢迎您成为 **[NoneBot2贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** ！ +此时，您可以在 **[NoneBot2 商店](https://v2.nonebot.dev/store.html)** 的插件页签查找到您的插件。同时，欢迎您成为 **[NoneBot2 贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** ！ **Congratulations!**