📝 migrate admonition title syntax to Docusaurus v3 bracket form

2026-07-26 02:02:43 +00:00 · 2026-07-22 22:59:41 +08:00
parent 3ffdedb8e2
commit 972bfe623b
143 changed files with 358 additions and 358 deletions
@@ -237,7 +237,7 @@ args = Args["foo", BasePattern("@\d+")]

 传入别名后，选项与子命令会选择其中长度最长的作为其名称。若传入为 "--foo|-f"，则命令名称为 "--foo"

-:::tip 特别提醒!!!
+:::tip[特别提醒!!!]

 Option 的名字或别名**没有要求**必须在前面写上 `-`

@@ -44,7 +44,7 @@ config_dir = store.get_plugin_config_dir()
 config_file = store.get_plugin_config_file("file_name")
 ```

-:::danger 警告
+:::danger[警告]
 在 Windows 和 macOS 系统下，插件的数据目录和配置目录是同一个目录，因此在使用时需要注意避免文件名冲突。
 :::

@@ -60,7 +60,7 @@ data_file.write_text("Hello World!")
 data = data_file.read_text()
 ```

-:::note 提示
+:::note[提示]

 对于嵌套插件，子插件的存储目录将位于父插件存储目录下。

@@ -178,7 +178,7 @@ op.drop_table("weather_weather")  # DROP TABLE weather_weather;
 对了，不要忘记还有一段注释：`commands auto generated by Alembic - please adjust!`。
 它在提醒我们，这些代码是由 Alembic 自动生成的，我们应该检查它们，并且根据需要进行调整。

-:::warning 注意
+:::warning[注意]
 迁移脚本冗长且繁琐，我们一般不会手写它们，而是由 Alembic 自动生成。
 一般情况下，Alembic 足够智能，可以正确地生成迁移脚本。
 但是，在复杂或有歧义的情况下，我们可能需要手动调整迁移脚本。
@@ -235,7 +235,7 @@ async def _(session: async_scoped_session, args: Message = CommandArg()):
 `async_scoped_session` 是一个有作用域限制的会话，作用域为当前事件、当前事件响应器。
 会话产生的模型实例（例如此处的 `wea := await session.get(Weather, location)`）作用域与会话相同。

-:::warning 注意
+:::warning[注意]
 此处提到的“会话”指的是 ORM 会话，而非 [NoneBot 会话](../../../appendices/session-control)，两者的生命周期也是不同的（NoneBot 会话的生命周期中可能包含多个事件，不同的事件也会有不同的事件响应器）。
 具体而言，就是不要将 ORM 会话和模型实例存储在 NoneBot 会话状态中：

@@ -8,7 +8,7 @@ description: 用户指南
 `nonebot-plugin-orm` 功能强大且复杂，使用上有一定难度。
 不过，对于用户而言，只需要掌握部分功能即可。

-:::warning 注意
+:::warning[注意]
 请注意区分插件的项目名（如：`nonebot-plugin-wordcloud`）和模块名（如：`nonebot_plugin_wordcloud`）。`nonebot-plugin-orm` 中统一使用插件模块名。参见 [插件命名规范](../../developer/plugin-publishing#插件命名规范)。
 :::

@@ -152,7 +152,7 @@ SQLALCHEMY_ENGINE_OPTIONS='{
 SQLALCHEMY_ECHO=true
 ```

-:::warning 注意
+:::warning[注意]
 以上配置之间有覆盖关系，遵循特殊优先于一般的原则，具体为 [`sqlalchemy_database_url`](#sqlalchemy_database_url) > [`sqlalchemy_bind`](#sqlalchemy_bind) > [`sqlalchemy_echo`](#sqlalchemy_echo) > [`sqlalchemy_engine_options`](#sqlalchemy_engine_options)。
 但覆盖顺序并非显而易见，出于清晰考虑，请只配置必要的选项。
 :::
@@ -27,7 +27,7 @@ nb plugin install nonebot-plugin-sentry

 ### 配置插件

-:::warning 注意
+:::warning[注意]
 错误跟踪通常在生产环境中使用，因此开发环境中 `sentry_dsn` 留空即会停用插件。
 :::

@@ -30,7 +30,7 @@ nb plugin install nonebot-plugin-htmlkit
 - Linux x64 （非 Alpine 等 musl 系发行版）
 - Linux arm64 （非 Alpine 等 musl 系发行版）

-:::warning 访问网络内容
+:::warning[访问网络内容]

 如果需要访问网络资源（如 http(s) 网页内容），NoneBot 需要客户端型驱动器（Forward）。内置的驱动器有 `~httpx` 与 `~aiohttp`。

@@ -12,7 +12,7 @@ import TabItem from "@theme/TabItem";

 由于不同平台的事件与接口之间，存在着极大的差异性，NoneBot 通过[重载](../appendices/overload.md)的方式，使得插件可以在不同平台上正确响应。但为了减少跨平台的兼容性问题，我们应该尽可能的使用基类方法实现原生跨平台，而不是使用特定平台的方法。当基类方法无法满足需求时，我们可以使用依赖注入的方式，将特定平台的事件或机器人注入到事件处理函数中，实现针对特定平台的处理。

-:::tip 提示
+:::tip[提示]
 如果需要在多平台上**使用**跨平台插件，首先应该根据[注册适配器](../advanced/adapter.md#注册适配器)一节，为机器人注册各平台对应的适配器。
 :::

@@ -58,7 +58,7 @@ scheduler.add_job(
 )
 ```

-:::warning 注意
+:::warning[注意]
 由于 APScheduler 的定时任务并不是**由事件响应器所触发的事件**，因此其任务函数无法同[事件处理函数](../tutorial/handler.mdx#事件处理函数)一样通过[依赖注入](../tutorial/event-data.mdx#认识依赖注入)获取上下文信息，也无法通过事件响应器对象的方法进行任何操作，因此我们需要使用[调用平台 API](../appendices/api-calling.mdx#调用平台-api)的方式来获取信息或收发消息。

 相对于事件处理依赖而言，编写定时任务更像是编写普通的函数，需要我们自行获取信息以及发送信息，请**不要**将事件处理依赖的特殊语法用于定时任务！
@@ -14,7 +14,7 @@ import TabItem from "@theme/TabItem";

 为了保证代码的正确运行，我们不仅需要对错误进行跟踪，还需要对代码进行正确性检验，也就是测试。NoneBot 提供了一个测试工具——NoneBug，它是一个 [pytest](https://docs.pytest.org/en/stable/) 插件，可以帮助我们便捷地进行单元测试。

-:::tip 提示
+:::tip[提示]
 建议在阅读本文档前先阅读 [pytest 官方文档](https://docs.pytest.org/en/stable/)来了解 pytest 的相关术语和基本用法。
 :::

@@ -23,7 +23,7 @@ NoneBug 提供了六种定义 `Rule` 和 `Permission` 预期行为的方法：
 - `should_not_pass_permission`
 - `should_ignore_permission`

-:::tip 提示
+:::tip[提示]
 事件响应器类型的检查属于 `Permission` 的一部分，因此可以通过 `should_pass_permission` 和 `should_not_pass_permission` 方法来断言事件响应器类型的检查。
 :::