Skip to content

Commit 246cf8d

Browse files
committed
update docs
1 parent 0b9ca47 commit 246cf8d

File tree

8 files changed

+1067
-399
lines changed

8 files changed

+1067
-399
lines changed

docs/.vuepress/config.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ export default defineUserConfig({
6565
watermark: true,
6666
markdownPower: {
6767
icons: true,
68-
bilibili: true,
6968
},
7069
markdownEnhance: {
7170
mermaid: true,

docs/guide/reference/transaction.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ async def get_pagination_apis(db: CurrentSession) -> ResponseModel:
3939

4040
这种方式由 SQLAlchemy 官方实现,在线程安全方面,由于在同一个函数中,可能存在多次调用,所以没有 Session 生成器严谨
4141

42-
```python
43-
# [!code word:begin]
42+
```python{2}
4443
async def create(*, obj: CreateIns) -> None:
4544
async with async_db_session.begin() as db:
4645
await xxx_dao.create(db, obj)

docs/guide/summary/quick-start.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,23 +235,21 @@ title: 快速开始
235235
::: steps
236236

237237
1. 定义数据库模型(model)
238-
239238
2. 定义数据验证模型(schema)
240-
241239
3. 定义视图(api)和路由(router)
242-
243240
4. 编写业务(service)
244241

245242
5. 编写数据库操作(crud)
246-
:::
243+
244+
:::
247245

248246
## 单元测试
249247

250248
::: info
251249
通过 `pytest` 运行单元测试,项目内仅提供了非常简易的 demo,并不是完整单元测试,如需要,请自行编写
252250
:::
253251

254-
:::: steps
252+
::: steps
255253

256254
1. 创建测试数据库 `fba_test`,选择 utf8mb4 编码,postgres 用户可忽略编码
257255
2. 创建数据库表,执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
@@ -262,4 +260,4 @@ title: 快速开始
262260
pytest -vs --disable-warnings
263261
```
264262

265-
::::
263+
:::

docs/planet.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ title: 知识星球
77

88
附:星球用于 [有偿赞助](../../sponsors.md#有偿赞助),加入 Discord
99
社区,即可 [领取免费体验资格](https://discord.gg/Sdg6dT5kjz)
10-
<p style="color: yellow">如果您觉得还不错,再选择正式加入即可</p>
1110
</div>
1211

13-
::: details 我要正式加入
12+
::: details 如果您觉得还不错,快来正式加入订阅吧
1413
<div align="center">
15-
<p>大额优惠已发放,速速加入 <a href="https://discord.gg/Sdg6dT5kjz">Discord</a> 免费领取吧</p>
14+
<p style="color: yellow">大额优惠券已发放,速速加入 <a href="https://discord.gg/Sdg6dT5kjz">Discord</a> 免费领取吧</p>
1615
<img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
1716
</div>
1817
:::

docs/plugin/before.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: 前言
1010

1111
提供一个共创平台,告别高耦合集成,让功能变得可轻松 Hot Swap(热插拔)
1212

13-
遗憾的是,我们并不会提供类似于会员制的插件系统对插件进行统一管理,我们计划将所有插件在 [插件市场](market.md) 进行展示和导航
13+
遗憾的是,我们并不会提供会员制插件后台管理平台对插件进行统一管理,我们计划将所有插件在 [插件市场](market.md) 进行展示和导航
1414

1515
## 开发
1616

@@ -26,14 +26,14 @@ title: 前言
2626

2727
## 可商用吗
2828

29-
请务必遵守插件代码许可证
29+
取决于插件开发者
3030

3131
## 技术支持
3232

33-
插件作者需提供至少一种联系方式且必须加入 Discord 社区,我们会在 Discord 为每个插件提供独立互动频道
33+
插件作者需提供至少一种联系方式且必须加入 Discord 社区,我们会在社区内为每个插件提供独立互动频道
3434

35-
第三方插件用户需自行联系第三方插件作者,我们不提供第三方插件技术支持
35+
第三方插件用户需自行联系第三方插件作者,我们不提供任何第三方插件技术支持
3636

3737
## 免责声明
3838

39-
我们会尽可能加强审核力度,但对于插件作者跑路行为,我们不承担任何责任
39+
我们会尽可能的加强插件审核力度,但对于插件作者跑路行为,我们不承担任何责任

docs/plugin/market.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,46 @@
22
title: 插件市场
33
---
44

5-
> [!IMPORTANT]
6-
> 插件需要人工审核,请 [点击此处](https://discord.gg/5SDAZgDya9) 与我们联系,一旦插件符合要求,我们会立即更新至此页面
7-
8-
## 官方
9-
10-
这些插件由 FBA 开发人员维护
11-
12-
### 免费
5+
::: warning
6+
插件功能目前处于测试阶段,如有任何建议,请立即和我们 [反馈](https://discord.com/channels/1185035164577972344/1332032404663046204)
7+
8+
:::
139

14-
即将到来...
10+
::: info
11+
你可以在 [插件互动频道](https://discord.gg/5SDAZgDya9) 与插件作者及社区人员进行互动和交流
12+
:::
1513

16-
### 付费
14+
> [!IMPORTANT]
15+
> 插件需要人工审核,请 [点击此处](https://discord.com/channels/1185035164577972344/1332032404663046204)
16+
> 与我们联系,一旦插件审核通过,我们会立即更新至此页面
1717
18-
请移步 [知识星球](../planet.md#插件)
18+
## 插件标签
1919

20-
## 第三方
20+
- <Badge type="tip" text="free" /> - 免费
21+
- <Badge type="danger" text="pay" /> - 付费
22+
- <Badge type="info" text="fba" /> - 仅后端
23+
- <Badge type="info" text="fba-arco" /> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui)
24+
- <Badge type="info" text="fba-vben" /> - 包含前端 [fba_ui](https://github.com/fastapi-practices/fba_ui)
2125

22-
这些插件由社区中的开发者提供
26+
## 官方
2327

24-
### 免费
28+
这些插件由 FBA 开发人员提供和维护
2529

26-
暂无
30+
<CardGrid>
31+
<LinkCard title="通知公告" href="https://discord.com/channels/1185035164577972344/1336557178437373984">
32+
<p>添加后台通知公告功能</p>
33+
<span>
34+
<Badge type="tip" text="free" />
35+
<Badge type="info" text="fba" />
36+
</span>
37+
</LinkCard>
38+
</CardGrid>
2739

40+
## 第三方
2841

29-
### 付费
42+
这些插件由社区中的开发者提供和维护
3043

31-
暂无
44+
<CardGrid>
45+
<Card title="空空如也">
46+
</Card>
47+
</CardGrid>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"sass-embedded": "^1.83.0",
2020
"vue": "^3.5.13",
2121
"vuepress": "2.0.0-rc.19",
22-
"vuepress-theme-plume": "1.0.0-rc.123"
22+
"vuepress-theme-plume": "1.0.0-rc.129"
2323
},
2424
"dependencies": {
2525
"@iconify/json": "^2.2.282",

0 commit comments

Comments
 (0)