📝 Docs: 升级到 Docusaurus V3 (#2956)

.github/workflows/release-drafter.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Update Changelog
         uses: docker://ghcr.io/nonebot/auto-changelog:master
         with:
-          changelog_file: website/src/pages/changelog.md
+          changelog_file: website/src/changelog/changelog.md
           latest_changes_position: '# 更新日志\n\n'
           latest_changes_title: "## 最近更新"
           replace_regex: '(?<=## 最近更新\n)[\s\S]*?(?=\n## )'

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Archive Changelog
         uses: docker://ghcr.io/nonebot/auto-changelog:master
         with:
-          changelog_file: website/src/pages/changelog.md
+          changelog_file: website/src/changelog/changelog.md
           archive_regex: '(?<=## )最近更新(?=\n)'
           archive_title: ${{ env.TAG_NAME }}
           commit_and_push: false

.gitignore

@@ -7,6 +7,7 @@ docs_build/_build
 !tests/.env
 .docusaurus
 website/docs/api/**/*.md
+website/src/pages/changelog/**/*
 
 # Created by https://www.toptal.com/developers/gitignore/api/python,node,visualstudiocode,jetbrains,macos,windows,linux
 # Edit at https://www.toptal.com/developers/gitignore?templates=python,node,visualstudiocode,jetbrains,macos,windows,linux

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-See [changelog.md](./website/src/pages/changelog.md) or <https://nonebot.dev/changelog>
+See [changelog.md](./website/src/changelog/changelog.md) or <https://nonebot.dev/changelog>

nonebot/__init__.py

@@ -39,6 +39,8 @@
 - `require` => {ref}``require` <nonebot.plugin.load.require>`
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 0
     description: nonebot 模块
 """

nonebot/adapters/__init__.py

@@ -3,6 +3,8 @@
 使用 {ref}`nonebot.drivers.Driver.register_adapter` 注册适配器。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 0
     description: nonebot.adapters 模块
 """

nonebot/compat.py

@@ -3,6 +3,8 @@
 为兼容 Pydantic V1 与 V2 版本，定义了一系列兼容函数与类供使用。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 16
     description: nonebot.compat 模块
 """

nonebot/config.py

@@ -7,6 +7,8 @@
 详情见 [`pydantic Field Type`](https://pydantic-docs.helpmanual.io/usage/types/) 文档。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 1
     description: nonebot.config 模块
 """

nonebot/consts.py

@@ -1,6 +1,8 @@
 """本模块包含了 NoneBot 事件处理过程中使用到的常量。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 9
     description: nonebot.consts 模块
 """

nonebot/dependencies/__init__.py

@@ -1,6 +1,8 @@
 """本模块模块实现了依赖注入的定义与处理。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 0
     description: nonebot.dependencies 模块
 """

nonebot/dependencies/utils.py

@@ -1,5 +1,7 @@
 """
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 1
     description: nonebot.dependencies.utils 模块
 """

nonebot/drivers/__init__.py

@@ -3,6 +3,8 @@
 各驱动请继承以下基类。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 0
     description: nonebot.drivers 模块
 """

nonebot/drivers/aiohttp.py

@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 2
     description: nonebot.drivers.aiohttp 模块
 """

nonebot/drivers/fastapi.py

@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 1
     description: nonebot.drivers.fastapi 模块
 """

nonebot/drivers/httpx.py

@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 3
     description: nonebot.drivers.httpx 模块
 """

nonebot/drivers/none.py

@@ -5,6 +5,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 6
     description: nonebot.drivers.none 模块
 """

nonebot/drivers/quart.py

@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 5
     description: nonebot.drivers.quart 模块
 """

nonebot/drivers/websockets.py

@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 4
     description: nonebot.drivers.websockets 模块
 """

nonebot/exception.py

@@ -25,6 +25,8 @@
 ```
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 10
     description: nonebot.exception 模块
 """

nonebot/log.py

@@ -8,6 +8,8 @@
 [loguru]: https://github.com/Delgan/loguru
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 7
     description: nonebot.log 模块
 """

nonebot/matcher.py

@@ -1,6 +1,8 @@
 """本模块实现事件响应器的创建与运行，并提供一些快捷方法来帮助用户更好的与机器人进行对话。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 3
     description: nonebot.matcher 模块
 """

nonebot/message.py

@@ -3,6 +3,8 @@
 NoneBot 内部处理并按优先级分发事件给所有事件响应器，提供了多个插槽以进行事件的预处理等。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 2
     description: nonebot.message 模块
 """

nonebot/params.py

@@ -1,6 +1,8 @@
 """本模块定义了依赖注入的各类参数。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 4
     description: nonebot.params 模块
 """

nonebot/permission.py

@@ -5,6 +5,8 @@
 只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 6
     description: nonebot.permission 模块
 """

nonebot/plugin/__init__.py

@@ -32,6 +32,8 @@
 - `PluginMetadata` => {ref}``PluginMetadata` <nonebot.plugin.model.PluginMetadata>`
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 0
     description: nonebot.plugin 模块
 """

nonebot/plugin/load.py

@@ -1,6 +1,8 @@
 """本模块定义插件加载接口。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 1
     description: nonebot.plugin.load 模块
 """

nonebot/plugin/manager.py

@@ -3,6 +3,8 @@
 参考: [import hooks](https://docs.python.org/3/reference/import.html#import-hooks), [PEP302](https://www.python.org/dev/peps/pep-0302/)
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 5
     description: nonebot.plugin.manager 模块
 """

nonebot/plugin/model.py

@@ -1,6 +1,8 @@
 """本模块定义插件相关信息。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 3
     description: nonebot.plugin.model 模块
 """

nonebot/plugin/on.py

@@ -1,6 +1,8 @@
 """本模块定义事件响应器便携定义函数。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 2
     description: nonebot.plugin.on 模块
 """

nonebot/rule.py

@@ -5,6 +5,8 @@
 只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 5
     description: nonebot.rule 模块
 """

nonebot/typing.py

@@ -6,6 +6,8 @@
 [`typing`](https://docs.python.org/3/library/typing.html)。
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 11
     description: nonebot.typing 模块
 """

nonebot/utils.py

@@ -1,6 +1,8 @@
 """本模块包含了 NoneBot 的一些工具函数
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 8
     description: nonebot.utils 模块
 """

pyproject.toml

@@ -22,7 +22,7 @@ include = ["nonebot/py.typed"]
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/nonebot/nonebot2/issues"
 "Changelog" = "https://nonebot.dev/changelog"
-"Funding" = "https://afdian.net/@nonebot"
+"Funding" = "https://afdian.com/@nonebot"
 
 [tool.poetry.dependencies]
 python = "^3.9"

website/docs/appendices/config.mdx

@@ -166,7 +166,7 @@ COMMON_CONFIG=common config  # 这个配置项在任何环境中都会被加载
 在生产环境中，可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。
 :::
 
-#### .env.{ENVIRONMENT} 文件
+#### .env.\{ENVIRONMENT\} 文件
 
 `.env.{ENVIRONMENT}` 文件类似于预设，可以让我们在多套不同的配置方案中灵活切换，默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目，那么将含有两套预设配置：`.env.dev` 和 `.env.prod`。
 

website/docs/best-practice/alconna/command.md

@@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
 assert alc.parse(".rd123").header["roll"] == 123
 ```
 
-Bracket Header 类似 python 里的 f-string 写法，通过 "{}" 声明匹配类型
+Bracket Header 类似 python 里的 f-string 写法，通过 `"{}"` 声明匹配类型
 
-"{}" 中的内容为 "name:type or pat"：
+`"{}"` 中的内容为 "name:type or pat"：
 
-- "{}", "{:}" ⇔ "(.+)", 占位符
-- "{foo}" ⇔ "(?P<foo>.+)"
-- "{:\d+}" ⇔ "(\d+)"
-- "{foo:int}" ⇔ "(?P<foo>\d+)"，其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式
+- `"{}"`, `"{:}"` ⇔ `"(.+)"`, 占位符
+- `"{foo}"` ⇔ `"(?P<foo>.+)"`
+- `"{:\d+}"` ⇔ `"(\d+)"`
+- `"{foo:int}"` ⇔ `"(?P<foo>\d+)"`，其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式
 
 ## 参数声明(Args)
 
@@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
 - `keep_crlf`: 命令解析时是否保留换行字符
 - `compact`: 命令是否允许第一个参数紧随头部
 - `strict`: 命令是否严格匹配，若为 False 则未知参数将作为名为 $extra 的参数
-- `context_style`: 命令上下文插值的风格，None 为关闭，bracket 为 {...}，parentheses 为 $(...)
+- `context_style`: 命令上下文插值的风格，None 为关闭，bracket 为 `{...}`，parentheses 为 `$(...)`
 - `extra`: 命令的自定义额外信息
 
 元数据一定使用 `meta=...` 形式传入：

website/docs/best-practice/alconna/uniseg.mdx

@@ -96,7 +96,7 @@ class Other(Segment):
 
 ```
 
-:::tips
+:::tip
 
 或许你注意到了 `Segment` 上有一个 `children` 属性。
 
@@ -291,7 +291,7 @@ msg.extend([Text("text")])
 
 这里额外说明 `UniMessage.template` 的拓展控制符
 
-相比 `Message`，UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
+相比 `Message`，UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
 
 以 At(...) 为例：
 
@@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
 UniMessage(At("user", "123"))
 ```
 
-而在 `AlconnaMatcher` 中，{:XXX} 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能：
+而在 `AlconnaMatcher` 中，`{:XXX}` 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能：
 
 ```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
 from arclet.alconna import Alconna, Args

website/docs/ospp/2021.md

@@ -1,13 +1,15 @@
 ---
 sidebar_position: 0
 description: 开源软件供应链点亮计划 - 暑期 2021
+mdx:
+  format: md
 ---
 
 # 暑期 2021
 
 **开源软件供应链点亮计划 - 暑期 2021** 是**中国科学院软件研究所**与 **openEuler 社区**共同举办的一项面向高校学生的暑期活动，旨在鼓励在校学生积极参与开源软件的开发维护，促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式，请查看该活动的 [官网](https://summer.iscas.ac.cn/) 和 [帮助文档](https://summer.iscas.ac.cn/help/)。
 
-NoneBot 社区有幸作为开源社区参与了本次活动，下面列出了目前我们已经发布的项目，欢迎感兴趣的同学在上面给出的活动官网报名，或通过 <[email protected]> 联系我们。
+NoneBot 社区有幸作为开源社区参与了本次活动，下面列出了目前我们已经发布的项目，欢迎感兴趣的同学在上面给出的活动官网报名，或通过 [[email protected]](mailto:[email protected]) 联系我们。
 
 ## NoneBot v1
 

website/docs/ospp/2022.md

@@ -1,13 +1,15 @@
 ---
 sidebar_position: 1
 description: 开源之夏 - 暑期 2022
+mdx:
+  format: md
 ---
 
 # 暑期 2022
 
 **开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动，类似 Google Summer of Code（GSoC），旨在鼓励在校学生积极参与开源软件的开发维护，促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式，请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。
 
-NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/#/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a/) 了本次活动，下面列出了目前我们已经发布的项目，欢迎感兴趣的同学加入 QQ 群 [737131827](https://jq.qq.com/?_wv=1027&k=PEgyGeEu) 或通过 <[email protected]> 联系我们。
+NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/#/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a/) 了本次活动，下面列出了目前我们已经发布的项目，欢迎感兴趣的同学加入 QQ 群 [737131827](https://jq.qq.com/?_wv=1027&k=PEgyGeEu) 或通过 [[email protected]](mailto:[email protected]) 联系我们。
 
 ## NoneBot2 命令行 CLI 交互体验升级