📝 migrate admonition title syntax to Docusaurus v3 bracket form

This commit is contained in:
StarHeartHunt
2026-07-22 22:59:41 +08:00
parent 3ffdedb8e2
commit 972bfe623b
143 changed files with 358 additions and 358 deletions
+2 -2
View File
@@ -26,7 +26,7 @@ NoneBot 适配器项目通常以 `nonebot-adapter-{adapter-name}` 作为项目
└── 📜 README.md
```
:::tip 提示
:::tip[提示]
上述的项目结构仅作推荐,不做强制要求,保证实际可用性即可。
@@ -44,7 +44,7 @@ nb adapter create
## 组成部分
:::tip 提示
:::tip[提示]
本章节的代码中提到的 `Adapter``Bot``Event``Message` 等,均为下文中适配器所编写的类,而非 NoneBot 中的基类。
+9 -9
View File
@@ -10,13 +10,13 @@ import TabItem from "@theme/TabItem";
NoneBot 为开发者提供了分享插件的官方商店。本指南囊括**从创建项目到发布到 PyPI,最终提交商店审核**的全过程。
:::warning 警告
:::warning[警告]
如果你的插件只是满足自用需求,则完全可以选择**不发布插件**。发布插件**不是**使用插件的必要条件。
NoneBot 社区对于插件有一定质量要求,对于不符合要求的插件,社区成员将会要求修改,直至符合要求后才能通过审核;如果长期未更新修改,社区将会关闭当前请求,之后如需发布请重新提交发布插件请求。相应的要求会在本章节以下部分介绍。
:::
:::tip 提示
:::tip[提示]
本章节仅包含插件发布流程指导,插件开发请查阅前述章节。
:::
@@ -35,7 +35,7 @@ NoneBot 插件使用下述命名规范:
### 项目结构
:::tip 提示
:::tip[提示]
本段所述的项目结构仅作推荐,不做强制要求。
:::
@@ -58,7 +58,7 @@ NoneBot 插件使用下述命名规范:
为降低新手门槛,我们提供三条清晰、完整、可复制的发布路径。
:::tip 提示
:::tip[提示]
你只需选择一条与你习惯一致的路径,**完整跟随即可成功发布**。无需在不同工具间切换或猜测配置。
:::
@@ -94,7 +94,7 @@ NoneBot 生态目前有如下插件项目模板:
然后在本地克隆仓库,使用编辑器对以下内容进行**全局替换**:
:::tip 提示
:::tip[提示]
此部分以“天气插件”为例,实际的替换内容应该根据你所创建的插件名称等相应调整。
:::
@@ -311,7 +311,7 @@ git push origin --tags
<TabItem value="manual" label="手动发布">
根据选用的构建系统,在项目的 `pyproject.toml` 中填入必要信息后进行构建与发布。
:::tip 提示
:::tip[提示]
不同构建工具的使用可能存在差别。本文仅以 [`pdm`](https://pdm-project.org/zh/latest/),
[`poetry`](https://python-poetry.org/docs/), [`setuptools`](https://setuptools.pypa.io/en/latest/)
构建系统**本地构建与发布**为示例讲解,其余构建/管理工具等和自动化构建的用法请读者自行探索。
@@ -357,7 +357,7 @@ twine upload dist/* # 只发布先前的构建
</TabItem>
</Tabs>
:::tip 提示
:::tip[提示]
发布前建议自行测试构建包是否可用,避免遗漏代码文件或资源文件等问题。
:::
@@ -422,7 +422,7 @@ __plugin_meta__ = PluginMetadata(
)
```
:::warning 注意
:::warning[注意]
`__plugin_meta__` 变量**必须**处于插件最外层(如 `__init__.py` 中),否则无法正常识别。
一般做法是在 `__init__.py` 中定义 `__plugin_meta__`。
@@ -549,7 +549,7 @@ weather_data_file: Path = store.get_plugin_data_file("resource-index.json")
插件发布 Issue 创建后,将会经过 **NoneFlow Bot** 的自动前置检查,以确保插件信息正确无误、插件能被正确加载。
:::tip 提示
:::tip[提示]
若插件检查未通过或信息有误,**不必**关闭当前 Issue。只需更新插件并上传到 PyPI/修改信息后勾选插件测试勾选框即可重新触发插件检查。
:::