📝 Docs: 修改更新部分文档 (#1615)

This commit is contained in:
Ju4tCode 2023-01-22 15:18:26 +08:00 committed by GitHub
parent 5893fbe57d
commit 5920efb6c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 12 deletions

View File

@ -135,12 +135,17 @@ NoneBot2 不是 NoneBot1 的替代品。事实上,它们都在被积极的维
懒得看文档?下面是快速安装指南: 懒得看文档?下面是快速安装指南:
1. (**强烈建议**)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。 1. 安装 [pipx](https://pypa.github.io/pipx/)
2. 使用 `pip` (或其他) 安装 NoneBot 脚手架。
```bash ```bash
pip install nb-cli python -m pip install --user pipx
python -m pipx ensurepath
```
2. 安装脚手架
```bash
pipx install nb-cli
``` ```
3. 使用脚手架创建项目 3. 使用脚手架创建项目
@ -149,6 +154,12 @@ NoneBot2 不是 NoneBot1 的替代品。事实上,它们都在被积极的维
nb create nb create
``` ```
4. 运行项目
```bash
nb run
```
## 社区资源 ## 社区资源
### 常见问题 ### 常见问题

View File

@ -27,13 +27,21 @@ pip uninstall nonebot
## 通过脚手架安装(推荐) ## 通过脚手架安装(推荐)
1. (可选)使用你喜欢的 Python 环境管理工具(如 Poetry、venv、Conda 等)创建新的虚拟环境 1. 安装 [pipx](https://pypa.github.io/pipx/)
2. 使用 pip 或其他包管理工具安装 nb-cliNoneBot2 会作为其依赖被一起安装
```bash ```bash
pip install nb-cli python -m pip install --user pipx
python -m pipx ensurepath
``` ```
2. 安装脚手架
```bash
pipx install nb-cli
```
安装完成后,你可以在命令行使用 `nb` 命令来使用脚手架。如果出现无法找到命令的情况(例如:`Command not found`),请参考 [pipx 文档](https://pypa.github.io/pipx/) 检查你的环境变量。
<Asciinema <Asciinema
url="https://asciinema.org/a/464654.cast" url="https://asciinema.org/a/464654.cast"
options={{ theme: "monokai", poster: "npt:2.8" }} options={{ theme: "monokai", poster: "npt:2.8" }}

View File

@ -10,10 +10,12 @@ options:
# 使用脚手架 # 使用脚手架
`nb-cli` 详细参考文档已移至 <https://cli.nonebot.dev>
## 安装 ## 安装
```bash ```bash
pip install nb-cli pipx install nb-cli
``` ```
## 初次使用 ## 初次使用
@ -21,14 +23,11 @@ pip install nb-cli
在安装完成之后,即可在命令行使用 nb-cli 的命令 `nb` 进行开发: 在安装完成之后,即可在命令行使用 nb-cli 的命令 `nb` 进行开发:
```bash ```bash
# 直接使用 nb 命令
nb nb
# 或使用 Python 执行 module
python -m nb_cli
``` ```
:::warning 注意 :::warning 注意
通常情况下,你可以直接在命令行使用 `nb` 命令,但如果命令行出现 `Command not found` 错误,这是由于环境变量 `PATH` 没有正确配置或未配置导致的,可以使用第二种方式代替 通常情况下,你可以直接在命令行使用 `nb` 命令。如果出现无法找到命令的情况(例如:`Command not found`),请参考 [pipx 文档](https://pypa.github.io/pipx/) 检查你的环境变量
::: :::
## 使用方式 ## 使用方式