📝 Docs: 升级新版 NonePress 主题 (#2375)

This commit is contained in:
Ju4tCode
2023-09-27 16:00:26 +08:00
committed by GitHub
parent 7754f6da1d
commit 842c6ff4c6
234 changed files with 8759 additions and 5887 deletions

View File

@ -4,15 +4,15 @@ description: 创建一个 NoneBot 项目
options:
menu:
weight: 20
category: tutorial
- category: tutorial
weight: 20
---
# 手动创建项目
在[快速上手](./quick-start.mdx)中,我们已经介绍了如何安装和使用 `nb-cli` 创建一个项目。在本章节中,我们将简要介绍如何在不使用 `nb-cli` 的方式创建一个机器人项目的**最小实例**并启动。如果你想要了解 NoneBot 的启动流程,也可以阅读本章节。
在[快速上手](../quick-start.mdx)中,我们已经介绍了如何安装和使用 `nb-cli` 创建一个项目。在本章节中,我们将简要介绍如何在不使用 `nb-cli` 的方式创建一个机器人项目的**最小实例**并启动。如果你想要了解 NoneBot 的启动流程,也可以阅读本章节。
:::warning
:::caution 警告
我们十分不推荐直接创建机器人项目,请优先考虑使用 nb-cli 进行项目创建。
:::
@ -44,7 +44,7 @@ options:
pip install 'nonebot2[fastapi]'
```
驱动器包名可以在 [驱动器商店](/store) 中找到。
驱动器包名可以在 [驱动器商店](/store/drivers) 中找到。
3. 安装适配器
@ -52,7 +52,7 @@ options:
pip install nonebot-adapter-console
```
适配器包名可以在 [适配器商店](/store) 中找到。
适配器包名可以在 [适配器商店](/store/adapters) 中找到。
## 创建配置文件

View File

@ -4,8 +4,8 @@ description: 创建并加载自定义插件
options:
menu:
weight: 50
category: tutorial
- category: tutorial
weight: 50
---
# 插件编写准备
@ -41,7 +41,7 @@ options:
## 创建插件
:::warning 注意
:::caution 注意
如果在之前的[快速上手](../quick-start.mdx)章节中已经使用 `bootstrap` 模板创建了项目,那么你需要做出如下修改:
1. 在项目目录中创建一个两层文件夹 `awesome_bot/plugins`
@ -63,7 +63,7 @@ options:
:::
:::warning 注意
:::caution 注意
如果在之前的[创建项目](./application.md)章节中手动创建了相关文件,那么你需要做出如下修改:
1. 在项目目录中创建一个两层文件夹 `awesome_bot/plugins`
@ -144,7 +144,7 @@ nonebot.load_plugin("path.to.your.plugin") # 加载第三方插件
nonebot.load_plugin(Path("./path/to/your/plugin.py")) # 加载项目插件
```
:::warning 注意
:::caution 注意
请注意,本地插件的路径应该为相对机器人 **入口文件(通常为 bot.py** 可导入的,例如在项目 `plugins` 目录下。
:::
@ -156,7 +156,7 @@ nonebot.load_plugin(Path("./path/to/your/plugin.py")) # 加载项目插件
nonebot.load_plugins("src/plugins", "path/to/your/plugins")
```
:::warning 注意
:::caution 注意
请注意,插件目录应该为相对机器人 **入口文件(通常为 bot.py** 可导入的,例如在项目 `plugins` 目录下。
:::

View File

@ -4,8 +4,8 @@ description: 通过依赖注入获取所需事件信息
options:
menu:
weight: 80
category: tutorial
- category: tutorial
weight: 80
---
# 获取事件信息

View File

@ -4,8 +4,8 @@ description: NoneBot 机器人构成及基本使用
options:
menu:
weight: 30
category: tutorial
- category: tutorial
weight: 30
---
# 机器人的构成

View File

@ -4,8 +4,8 @@ description: 处理接收到的特定事件
options:
menu:
weight: 70
category: tutorial
- category: tutorial
weight: 70
---
# 事件处理

View File

@ -4,8 +4,8 @@ description: 响应接收到的特定事件
options:
menu:
weight: 60
category: tutorial
- category: tutorial
weight: 60
---
# 事件响应器

View File

@ -4,8 +4,8 @@ description: 处理消息序列与消息段
options:
menu:
weight: 90
category: tutorial
- category: tutorial
weight: 90
---
# 处理消息
@ -26,7 +26,7 @@ options:
顾名思义,消息段 `MessageSegment` 是一段消息。由于消息序列的本质是由若干消息段所组成的序列,消息段可以被认为是构成消息序列的最小单位。简单来说,消息序列类似于一个自然段,而消息段则是组成自然段的一句话。同时,作为特殊消息载体的存在,绝大多数的平台都有着**独特的消息类型**,这些独特的内容均需要由对应的**协议适配器**所提供,以适应不同平台中的消息模式。**这也意味着,你需要导入对应的协议适配器中的消息序列和消息段后才能使用其特殊的工厂方法。**
:::warning 注意
:::caution 注意
消息段的类型是由协议适配器提供的,因此你需要参考协议适配器的文档并导入对应的消息段后才能使用其特殊的消息类型。
在上一节的[使用依赖注入](./event-data.mdx#使用依赖注入)中,我们导入的为 `nonebot.adapters.Message` 抽象基类,因此我们无法使用平台特有的消息类型。仅能使用 `str` 作为纯文本消息回复。
@ -34,7 +34,7 @@ options:
## 使用消息序列
:::warning 注意
:::caution 注意
在以下的示例中,为了更好的理解多种类型的消息组成方式,我们将使用 `Console` 协议适配器来演示消息序列的使用方法。在实际使用中,你需要确保你使用的**消息序列类型**与你所要发送的**平台类型**一致。
:::
@ -297,7 +297,7 @@ msg == Message(
如果 `Message.template` 构建消息模板,那么消息模板将采用消息序列形式的格式化,此时的消息将会是平台特定的:
:::warning 注意
:::caution 注意
使用 `Message.template` 构建消息模板时,应注意消息序列为平台适配器提供的类型,不能使用 `nonebot.adapters.Message` 基类作为模板构建。使用基类构建模板与使用 `str` 构建模板的效果是一样的,因此请使用上述的 `MessageTemplate` 类直接构建模板。:
:::
@ -337,7 +337,7 @@ Message(
)
```
:::warning 注意
:::caution 注意
只有消息序列中的文本类型消息段才能被格式化,其他类型的消息段将会原样添加。
:::

View File

@ -4,8 +4,8 @@ description: 从商店安装适配器和插件
options:
menu:
weight: 40
category: tutorial
- category: tutorial
weight: 40
---
# 获取商店内容
@ -15,10 +15,12 @@ import TabItem from "@theme/TabItem";
import Asciinema from "@site/src/components/Asciinema";
:::tip 提示
如果你暂时没有获取商店内容的需求,可以跳过本章节。
:::
NoneBot 提供了一个[商店](/store),商店内容均由社区开发者贡献。你可以在商店中查找你需要的适配器和插件等,进行安装或者参考其文档等。
NoneBot 提供了一个[商店](/store/plugins),商店内容均由社区开发者贡献。你可以在商店中查找你需要的适配器和插件等,进行安装或者参考其文档等。
商店中每个内容的卡片都包含了其名称和简介等信息,点击**卡片右上角**链接图标即可跳转到其主页。