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

This commit is contained in:
StarHeart
2024-10-22 10:33:48 +08:00
committed by GitHub
parent 533e8794b2
commit c1c5f57e0b
75 changed files with 6110 additions and 4739 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -8,6 +8,8 @@ NoneBot 使用 [`loguru`][loguru] 来记录日志信息。
[loguru]: https://github.com/Delgan/loguru
FrontMatter:
mdx:
format: md
sidebar_position: 7
description: nonebot.log 模块
"""

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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 模块
"""

View File

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

View File

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

View File

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

View File

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

View File

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