ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-27 16:21:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

📝 Fix copywriting

Browse Source
This commit is contained in:
jigsaw
2022-02-05 19:46:33 +08:00
parent b8456b12ad
commit b9fd4b1ac8
27 changed files with 321 additions and 332 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/start/editor-support.md
View File

@ -5,7 +5,7 @@ description: 编辑器支持
# 编辑器支持
框架基于 [PEP484](https://www.python.org/dev/peps/pep-0484/), [PEP 561](https://www.python.org/dev/peps/pep-0517/), [PEP8](https://www.python.org/dev/peps/pep-0008/) 等规范进行开发并且是 **Fully Typed**。框架使用 `pyright` (`pylance`) 工具进行类型检查，确保代码可以被编辑器正确解析。
框架基于 [PEP484](https://www.python.org/dev/peps/pep-0484/)、[PEP 561](https://www.python.org/dev/peps/pep-0517/)、[PEP8](https://www.python.org/dev/peps/pep-0008/) 等规范进行开发并且是 **Fully Typed**。框架使用 `pyright`（`pylance`）工具进行类型检查，确保代码可以被编辑器正确解析。
## 编辑器推荐配置

10
website/docs/start/install-adapter.mdx
View File

@ -1,6 +1,6 @@
---
sidebar_position: 2
description: 通过脚手架, pip 安装适配器
description: 通过脚手架或 pip 安装适配器
---
import Asciinema from "@site/src/components/Asciinema";
@ -9,9 +9,9 @@ import Asciinema from "@site/src/components/Asciinema";
## 查看
前往 [商店](/store) 即可查看所有协议适配器。
前往[商店](/store)即可查看所有协议适配器。
或者使用 `nb-cli` 命令行查看:
或者使用 nb-cli 命令行查看:
```bash
nb adapter list
@ -19,7 +19,7 @@ nb adapter list
## 安装
前往 [商店](/store) 点击复制 `nb-cli` 安装命令至命令行执行即可安装。
前往[商店](/store)点击复制 nb-cli 安装命令至命令行执行即可安装。
或者自行输入命令安装:
@ -33,7 +33,7 @@ nb adapter install <adapter-name>
nb adapter install
```
也可以使用 `pip` 安装
也可以使用 pip 安装
```bash
pip install <adapter-name>

12
website/docs/start/install-driver.mdx
View File

@ -1,19 +1,19 @@
---
sidebar_position: 1
description: 通过脚手架, pip 安装驱动器
description: 通过脚手架或 pip 安装驱动器
---
import Asciinema from "@site/src/components/Asciinema";
# 安装驱动器
NoneBot 在默认安装情况下内置了 `fastapi` 服务端驱动器，其他驱动器如 `httpx`, `aiohttp` 则需要额外安装。
NoneBot 在默认安装情况下内置了 `fastapi` 服务端驱动器，其他驱动器如 `httpx`、`aiohttp` 则需要额外安装。
## 查看
前往 [商店](/store) 即可查看所有驱动器。
前往[商店](/store)即可查看所有驱动器。
或者使用 `nb-cli` 命令行查看:
或者使用 nb-cli 命令行查看:
```bash
nb driver list
@ -21,7 +21,7 @@ nb driver list
## 安装
前往 [商店](/store) 点击复制 `nb-cli` 安装命令至命令行执行即可安装。
前往[商店](/store)点击复制 nb-cli 安装命令至命令行执行即可安装。
或者自行输入命令安装:
@ -35,7 +35,7 @@ nb driver install <driver-name>
nb driver install
```
也可以使用 `pip` 安装
也可以使用 pip 安装
```bash
pip install <driver-name>

10
website/docs/start/install-plugin.mdx
View File

@ -1,6 +1,6 @@
---
sidebar_position: 3
description: 通过脚手架, pip 安装插件
description: 通过脚手架或 pip 安装插件
---
import Asciinema from "@site/src/components/Asciinema";
@ -9,9 +9,9 @@ import Asciinema from "@site/src/components/Asciinema";
## 查看
前往 [商店](/store) 即可查看所有发布的插件。
前往[商店](/store)即可查看所有发布的插件。
或者使用 `nb-cli` 命令行查看:
或者使用 nb-cli 命令行查看:
```bash
nb plugin list
@ -19,7 +19,7 @@ nb plugin list
## 安装
前往 [商店](/store) 点击复制 `nb-cli` 安装命令至命令行执行即可安装。
前往[商店](/store)点击复制 nb-cli 安装命令至命令行执行即可安装。
或者自行输入命令安装:
@ -33,7 +33,7 @@ nb plugin install <plugin-name>
nb plugin install
```
也可以使用 `pip` 安装
也可以使用 pip 安装
```bash
pip install <plugin-name>

22
website/docs/start/installation.mdx
View File

@ -1,6 +1,6 @@
---
sidebar_position: 0
description: 通过脚手架, PyPI, GitHub 安装 NoneBot
description: 通过脚手架、PyPI 或 GitHub 安装 NoneBot2
options:
menu:
@ -10,7 +10,7 @@ options:
import Asciinema from "@site/src/components/Asciinema";
# 安装 NoneBot
# 安装 NoneBot2
:::warning 注意
请确保你的 Python 版本 >= 3.7.3。
@ -25,10 +25,10 @@ pip uninstall nonebot
:::
## 通过脚手架安装 (推荐)
## 通过脚手架安装（推荐）
1. (可选) 使用你喜欢的 Python 环境管理工具 (如 `poetry`, `venv`, `conda` 等) 创建新的虚拟环境
2. 使用 `pip` 或 其他包管理工具 安装 `nb-cli`，`nonebot2` 会作为其依赖被一起安装
1. （可选）使用你喜欢的 Python 环境管理工具（如 Poetry、venv、Conda 等）创建新的虚拟环境
2. 使用 pip 或其他包管理工具安装 nb-cli，NoneBot2 会作为其依赖被一起安装
```bash
pip install nb-cli
@ -40,16 +40,16 @@ pip uninstall nonebot
/>
:::important 提示
`nb-cli` 的使用方法详见 [使用脚手架](./nb-cli.md)
nb-cli 的使用方法详见[使用脚手架](./nb-cli.md)
:::
## 不使用脚手架 (纯净安装)
## 不使用脚手架（纯净安装）
如果你不想使用脚手架，可以直接安装 `nonebot2`，并自行完成开发配置。
如果你不想使用脚手架，可以直接安装 NoneBot2，并自行完成开发配置。
```bash
pip install nonebot2
# 也可以通过 poetry 安装
# 也可以通过 Poetry 安装
poetry add nonebot2
```
@ -58,12 +58,12 @@ poetry add nonebot2
如果你需要使用最新的（可能**尚未发布**的）特性，可以直接从 GitHub 仓库安装:
:::warning 注意
直接从 Github 仓库中安装意味着你将使用最新提交的代码，它们并没有进行充分的稳定性测试
直接从 GitHub 仓库中安装意味着你将使用最新提交的代码，它们并没有进行充分的稳定性测试
在任何情况下请不要将其应用于生产环境!
:::
```bash title="Install From Github"
```bash title="Install From GitHub"
# master分支
poetry add git+https://github.com/nonebot/nonebot2.git#master
# dev分支

6
website/docs/start/nb-cli.md
View File

@ -18,12 +18,12 @@ pip install nb-cli
## 初次使用
在安装完成之后，即可在命令行使用 `nb-cli` 的命令 `nb` 进行开发：
在安装完成之后，即可在命令行使用 nb-cli 的命令 `nb` 进行开发：
```bash
# 直接使用 nb 命令
nb
# 或使用 python 执行 module
# 或使用 Python 执行 module
python -m nb_cli
```
@ -33,7 +33,7 @@ python -m nb_cli
## 使用方式
`nb-cli` 具有两种使用方式：
nb-cli 具有两种使用方式：
1. 命令行指令

12
website/docs/start/question.md
View File

@ -7,22 +7,22 @@ description: 如何获取帮助
如果在安装或者开发过程中遇到了任何问题，可以通过以下方式解决：
1. 点击下方链接前往 GitHub ~~点击 star~~ ，前往 Issues 页面，在 `New Issue` Template 中选择 `Question`
1. 点击下方链接前往 GitHub，前往 Issues 页面，在 `New Issue` Template 中选择 `Question`
NoneBot2: [![nonebot2](https://img.shields.io/github/stars/nonebot/nonebot2?style=social)](https://github.com/nonebot/nonebot2)
NoneBot2：[![NoneBot2](https://img.shields.io/github/stars/nonebot/nonebot2?style=social)](https://github.com/nonebot/nonebot2)
2. 通过 QQ 群 (点击下方链接直达)
2. 通过 QQ 群（点击下方链接直达）
[![QQ Chat](https://img.shields.io/badge/QQ%E7%BE%A4-768887710-orange?style=social)](https://jq.qq.com/?_wv=1027&k=5OFifDh)
3. 通过 QQ 频道
前往 QQ 频道搜索 `NoneBot` 点击加入
前往 QQ 频道搜索 NoneBot 点击加入
4. 通过 Telegram 群 (点击下方链接直达)
4. 通过 Telegram 群（点击下方链接直达）
[![Telegram Chat](https://img.shields.io/badge/telegram-cqhttp-blue?style=social)](https://t.me/cqhttp)
5. 通过 Discord 服务器 (点击下方链接直达)
5. 通过 Discord 服务器（点击下方链接直达）
[![Discord Server](https://discordapp.com/api/guilds/847819937858584596/widget.png?style=shield)](https://discord.gg/VKtE6Gdc4h)