📝 add frontmatter to use md

nonebot · Sep 18, 2024 · 9f28b46 · 9f28b46
1 parent da1ffe8
commit 9f28b46
Show file tree

Hide file tree

Showing 28 changed files with 56 additions and 0 deletions.
diff --git a/nonebot/__init__.py b/nonebot/__init__.py
@@ -39,6 +39,8 @@
 - `require` => {ref}``require` <nonebot.plugin.load.require>`
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 0
     description: nonebot 模块
 """

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

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

diff --git a/nonebot/config.py b/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 模块
 """

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

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

diff --git a/nonebot/dependencies/utils.py b/nonebot/dependencies/utils.py
@@ -1,5 +1,7 @@
 """
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 1
     description: nonebot.dependencies.utils 模块
 """

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

diff --git a/nonebot/drivers/aiohttp.py b/nonebot/drivers/aiohttp.py
@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 2
     description: nonebot.drivers.aiohttp 模块
 """

diff --git a/nonebot/drivers/fastapi.py b/nonebot/drivers/fastapi.py
@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 1
     description: nonebot.drivers.fastapi 模块
 """

diff --git a/nonebot/drivers/httpx.py b/nonebot/drivers/httpx.py
@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 3
     description: nonebot.drivers.httpx 模块
 """

diff --git a/nonebot/drivers/none.py b/nonebot/drivers/none.py
@@ -5,6 +5,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 6
     description: nonebot.drivers.none 模块
 """

diff --git a/nonebot/drivers/quart.py b/nonebot/drivers/quart.py
@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 5
     description: nonebot.drivers.quart 模块
 """

diff --git a/nonebot/drivers/websockets.py b/nonebot/drivers/websockets.py
@@ -11,6 +11,8 @@
 :::
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 4
     description: nonebot.drivers.websockets 模块
 """

diff --git a/nonebot/exception.py b/nonebot/exception.py
@@ -25,6 +25,8 @@
 ```
 
 FrontMatter:
+    mdx:
+        format: md
     sidebar_position: 10
     description: nonebot.exception 模块
 """

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

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

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

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

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

diff --git a/nonebot/plugin/__init__.py b/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 模块
 """

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

diff --git a/nonebot/plugin/manager.py b/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 模块
 """

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

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

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

diff --git a/nonebot/typing.py b/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 模块
 """

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