Skip to content

Commit e7ec435

Browse files
committed
update docs
1 parent af7ae01 commit e7ec435

File tree

13 files changed

+47
-56
lines changed

13 files changed

+47
-56
lines changed

docs/.vuepress/navbar.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const myNavbar = defineNavbarConfig([
1010
//link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'
1111
},
1212
{
13-
text: 'Ant Desgin Vue 孵化中...',
13+
text: 'Vben Admin Antd 生产中...',
1414
link: 'https://github.com/fastapi-practices/fba_ui'
1515
}
1616
]
62.3 KB
Loading
71.8 KB
Loading
Loading

docs/guide/deploy/Docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -293,14 +293,14 @@ title: Docker 部署
293293
:::: details Arco Desgin Vue
294294

295295
::: caution
296-
这是一个实验版本,它仅用作效果演示,而不是用于生产!
296+
这是一个实验性实施,它仅用作效果演示,而不是用于生产!
297297
:::
298298

299299
修改 `.env.production` 中的 `VITE_API_BASE_URL` 为域名地址
300300
::::
301301

302-
:::: details Ant Desgin Vue
303-
生产可用?我知道你很急,但你先别急...
302+
:::: details Vben Admin Antd
303+
我知道你很急,但你先别急...
304304
::::
305305

306306
3. 更新 nginx 配置

docs/guide/mixin/user.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,12 @@ title: 用户信息
33
---
44

55
<div align="center">
6-
此内容为非公开内容,扫码加入知识星球,即可获取独家内容
76

87
<a href="https://t.zsxq.com/virtV">内容跳转</a>
98

10-
<span style="color: rgb(110, 110, 110);">
11-
我们不保证星球内容的更新频率,您可以依据星球规则进行全额退款
12-
</span>
9+
此内容为非公开内容,扫码加入知识星球,即可获取独家内容
1310

14-
<p style="font-size: 14px; color: rgb(110,110,110);">
15-
附:星球用作
16-
<a href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E6%9C%89%E5%81%BF%E8%B5%9E%E5%8A%A9">有偿赞助</a>
17-
,加入 Discord 社区,可领取免费体验资格
18-
</p>
11+
附:星球用作 [有偿赞助](../../sponsors.md#有偿赞助),加入 Discord 社区,即可 [领取免费体验资格](https://discord.com/invite/yNN3wTbVAC)
1912

2013
<img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
2114

docs/guide/reference/celery.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,12 @@ title: Celery
33
---
44

55
<div align="center">
6-
此内容为非公开内容,扫码加入知识星球,即可获取独家内容
76

87
<a href="https://t.zsxq.com/qk5gZ">内容跳转</a>
98

10-
<span style="color: rgb(110, 110, 110);">
11-
我们不保证星球内容的更新频率,您可以依据星球规则进行全额退款
12-
</span>
9+
此内容为非公开内容,扫码加入知识星球,即可获取独家内容
1310

14-
<p style="font-size: 14px; color: rgb(110,110,110);">
15-
附:星球用作
16-
<a href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E6%9C%89%E5%81%BF%E8%B5%9E%E5%8A%A9">有偿赞助</a>
17-
,加入 Discord 社区,可领取免费体验资格
18-
</p>
11+
附:星球用作 [有偿赞助](../../sponsors.md#有偿赞助),加入 Discord 社区,即可 [领取免费体验资格](https://discord.com/invite/yNN3wTbVAC)
1912

2013
<img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
2114

docs/guide/reference/code-generation.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@ title: 代码生成
33
---
44

55
> [!TIP]
6-
> 当前版本仅包含后端代码生成
7-
>
8-
> 代码生成器使用 api 调用实现,包含两个模组,设计可能存在缺陷,相关问题请直接提交 issues
6+
> 当前版本仅包含后端代码生成,代码生成器使用 api 调用实现,设计可能存在缺陷,相关问题请直接提交 issues
97
108
> [!WARNING]
11-
> 由于 jinja2 在渲染模版时,文本方式输出可能存在格式问题,所以 `preview` 接口可能无法直观预览代码,这是为前端进行的预设,
12-
> 你可以在我们的在线预览中更加直观的查看生成效果
9+
> api 调用无法直观的预览代码生成结果,它必须配合前端项目使用,查看 [效果预览](#效果预览)
1310
1411
## 概念
1512

13+
代码生成包含【业务】和【模型】两个模块
14+
1615
### 业务
1716

1817
包含代码生成的相关配置,详情查看:`generator/model/gen_business.py`
@@ -21,20 +20,28 @@ title: 代码生成
2120

2221
包含代码生成所需要的模型列信息,就像正常定义模型列一样,目前支持的功能有限
2322

24-
## 使用
23+
## 工作模式
2524

26-
### F. 纯手动模式
25+
目前包含两种工作模式,分别为手动和自动,手动已被标记为弃用,推荐使用自动模式
2726

28-
不推荐(手动创建业务接口被标记为「已弃用」)
27+
### 手动
2928

3029
1. 通过创建业务接口手动添加一项业务数据
3130
2. 通过模型创建接口手动添加模型列
32-
3. 访问 `preview`(预览),`generate`(磁盘写入),`download`(下载)接口,执行后端代码生成相应工作
31+
3. 访问 `preview`(预览)、`generate`(磁盘写入)、`download`(下载)接口
32+
33+
### 自动
34+
35+
1. 访问 `tables` 接口,自动获取数据库表名列表
36+
2. 访问 `import` 接口,导入数据库已有的数据库表,自动创建业务表数据和模型表数据
37+
3. 访问 `preview`(预览)、`generate`(磁盘写入)、`download`(下载)接口
38+
39+
## 效果预览
3340

34-
### S. 自动模式
41+
::: details Arco Desgin Vue
42+
![cg1](/images/code-generator1.png)
3543

36-
推荐
44+
![cg2](/images/code-generator2.png)
3745

38-
1. 访问 `tables` 接口,获取数据库表名列表
39-
2. 通过 `import` 接口,导入数据库已有的数据库表数据,将自动创建业务表数据和模型表数据
40-
3. 访问 `preview`(预览),`generate`(磁盘写入),`download`(下载)接口,执行后端代码生成相应工作
46+
![cg3](/images/code-generator3.png)
47+
:::

docs/guide/reference/data-rule.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,12 @@ title: 数据规则
33
---
44

55
<div align="center">
6-
此内容为非公开内容,扫码加入知识星球,即可获取独家内容
76

87
<a href="https://t.zsxq.com/qlZyT">内容跳转</a>
98

10-
<span style="color: rgb(110, 110, 110);">
11-
我们不保证星球内容的更新频率,您可以依据星球规则进行全额退款
12-
</span>
9+
此内容为非公开内容,扫码加入知识星球,即可获取独家内容
1310

14-
<p style="font-size: 14px; color: rgb(110,110,110);">
15-
附:星球用作
16-
<a href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E6%9C%89%E5%81%BF%E8%B5%9E%E5%8A%A9">有偿赞助</a>
17-
,加入 Discord 社区,可领取免费体验资格
18-
</p>
11+
附:星球用作 [有偿赞助](../../sponsors.md#有偿赞助),加入 Discord 社区,即可 [领取免费体验资格](https://discord.com/invite/yNN3wTbVAC)
1912

2013
<img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
2114

docs/guide/summary/quick-start.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ title: 快速开始
150150
::::: details Arco Desgin Vue
151151

152152
::: caution
153-
这是一个实验版本,它仅用作效果演示,而不是用于生产!
153+
这是一个实验性实施,它仅用作效果演示,而不是用于生产!
154154
:::
155155

156156
:::: steps
@@ -182,10 +182,8 @@ title: 快速开始
182182
::::
183183
:::::
184184

185-
::::: details Ant Desgin Vue
186-
187-
生产可用?我知道你很急,但你先别急...
188-
185+
::::: details Vben Admin Antd
186+
我知道你很急,但你先别急...
189187
:::::
190188

191189
## 开发流程

0 commit comments

Comments
 (0)