Skip to content

Commit 7bb90bc

Browse files
committed
update docs
1 parent e4af08e commit 7bb90bc

File tree

6 files changed

+60
-22
lines changed

6 files changed

+60
-22
lines changed

docs/.vuepress/_bulletin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
fba 已新增多租户模式适配:
44

55
- 开启方式:`TENANT_ENABLED = True`
6-
- 完整能力:安装 [tenant 插件](https://fastapi-practices.github.io/fastapi_best_architecture_docs/marketplace.html)
6+
- 完整能力:安装 [tenant](https://fastapi-practices.github.io/fastapi_best_architecture_docs/marketplace.html) 插件
77

88
::: caution
99
当前为实验性实施,相关适配可参考 [PR #1101](https://github.com/fastapi-practices/fastapi-best-architecture/pull/1101)

docs/.vuepress/navbar.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
44
{
55
text: 'Guide',
66
items: [
7+
{
8+
text: '工程化',
9+
items: [
10+
{
11+
text: 'CLI',
12+
icon: 'glyphs:cli-bold',
13+
link: '/cli'
14+
}
15+
]
16+
},
717
{
818
text: '后端',
919
items: [

docs/cli.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: CLI
3+
---
4+
5+
此 CLI 工具的实现与后端内置存在些许不同,目标用于完整的前后端工程
6+
7+
功能点包含:
8+
9+
- 一键创建、配置、管理 fba 工程(交互式引导流程)
10+
- 一键运行 fba / fba_ui 项目
11+
- 前后端插件一键管理
12+
- ...
13+
14+
如果你正在通过 fba 前后端构建项目,此工具将大幅简化项目初始化和日常开发操作
15+
16+
## 使用方式
17+
18+
1. 安装 fba-cli
19+
20+
```bash
21+
npm install -g @fba/cli
22+
```
23+
24+
2. 通过在终端输入 `fba-cli -h` 获取相关信息

docs/plugin/dev.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,7 @@ IDE 获取全局配置键入提示,这是必需的,相反,你们将无法
275275
- index.vue
276276
-
277277
- … 更多内容
278+
- plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
278279

279280
:::
280281

docs/plugin/install.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,11 @@ title: 插件安装
77
:::: tabs
88
@tab CLI
99

10-
1. 通过在命令行输入 `fba add -h` 获取相关信息
10+
1. 通过在终端输入 `fba add -h` 获取相关信息
1111
2. 通过 `fba add` 命令进行安装
1212
3. 根据插件说明(README.md)进行相关配置
1313
4. 重启服务
1414

15-
@tab GIT
16-
17-
1. 获取插件 git 仓库地址,理论上支持任何平台(GitHub、Gitlab、Gitee、Gitea...)
18-
2. 通过 fba git 插件安装接口进行安装
19-
3. 根据插件说明(README.md)进行相关配置
20-
4. 重启服务
21-
2215
@tab ZIP
2316

2417
1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
@@ -38,7 +31,7 @@ title: 插件安装
3831
@tab 手动
3932

4033
1. 获取插件仓库源码并下载
41-
2. 将下载的源码文件夹直接拷贝到 `backend/plugin` 目录下
34+
2. 将下载的源码文件夹拷贝到 `backend/plugin` 目录下(插件文件夹需要与仓库名保持一致)
4235
3. 根据插件说明(README.md)进行相关配置
4336
4. 重启服务
4437

@@ -50,6 +43,24 @@ title: 插件安装
5043

5144
## 前端
5245

46+
::: tabs
47+
@tab CLI
48+
49+
1. 安装 fba-cli
50+
51+
```bash
52+
npm install -g @fba/cli
53+
```
54+
55+
2. 通过在终端输入 `fba-cli add -h` 获取相关信息
56+
3. 通过 `fba-cli add` 命令进行安装
57+
4. 根据插件说明(README.md)进行相关配置
58+
5. 重启服务
59+
60+
@tab 手动
61+
5362
1. 获取插件仓库源码并下载
54-
2. 将下载的源码文件夹直接拷贝到 `apps/web-antd/src/plugins` 目录下
63+
2. 将下载的源码文件夹拷贝到 `apps/web-antd/src/plugins` 目录下(插件文件夹需要删除 `_ui` 后缀)
5564
3. 重启服务
65+
66+
:::

docs/plugin/share.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ title: 插件分享
77
## 后端
88

99
::: warning 插件仓库命名规则
10-
`仓库名 == 插件名`
10+
`插件名 == 仓库名` -> `ai == ai`
1111

1212
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性
1313
:::
1414

15-
假如仓库名为 `sms`,安装此插件后,`backend/plugin` 目录下就会新增一个 `sms` 文件夹
16-
17-
后端插件文件夹命名==不可=={.warning}随意修改,这将对整个插件内的代码造成影响
18-
1915
:::: steps
2016

2117
1. 创建插件 Github 仓库
@@ -38,17 +34,13 @@ title: 插件分享
3834
## 前端
3935

4036
::: warning 插件仓库命名规则
41-
`仓库名_ui == 插件名_ui`
37+
`插件名 == 仓库名_ui` -> `ai == ai_ui`
4238

43-
为了更好的与后端插件进行区分,需要为前端插件仓库名添加 `_ui` 后缀
39+
为了更好的与后端插件进行区分,必须为前端插件仓库名添加 `_ui` 后缀
4440

4541
插件总是独一无二的,不允许安装同名插件,所以在对插件进行命名时,应尽量保持其独特性
4642
:::
4743

48-
假如仓库名为 `sms_ui`,安装此插件后,`apps/web-antd/src/plugins` 目录下就会新增一个 `sms_ui` 文件夹
49-
50-
前端插件文件夹命名==可=={.warning}随意修改,这不会对插件内的代码造成影响
51-
5244
:::: steps
5345

5446
1. 创建个人插件仓库

0 commit comments

Comments
 (0)