Skip to content

Commit 0b51cf5

Browse files
committed
update docs
1 parent 5151494 commit 0b51cf5

File tree

8 files changed

+272
-281
lines changed

8 files changed

+272
-281
lines changed

docs/.vuepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ export default defineUserConfig({
3535
},
3636
bulletin: myBulletin,
3737
sidebar: mySidebar,
38+
sidebarScrollbar: false,
3839
navbar: myNavbar,
3940
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png',
4041
docsRepo: 'https://github.com/fastapi-practices/fastapi_best_architecture_docs',

docs/.vuepress/styles/custom.css

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
--vp-c-brand-1: rgba(0, 148, 133, 1); /* 链接颜色、强调色 */
44
--vp-c-brand-2: rgba(0, 148, 133, 1); /* 链接、按钮 hover 颜色 */
55
--vp-c-brand-3: rgba(0, 148, 133, 1); /* 背景色、边框色 */
6+
color: #4582ff;
7+
background-color: rgba(255, 255, 255, 0.16);
68
}
79

810
[data-theme="dark"] {

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
home: true
33
watermark: false
44
config:
5-
- type: 'hero'
5+
- type: hero
66
full: true
77
background: tint-plate
88
hero:

docs/guide/deploy/Docker.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ title: Docker 部署
3838
## 服务器部署
3939

4040
> [!TIP]
41-
> 此教程以 ==https== 为例,如果你没有相关经验,请自行 Google 进行了解
41+
> 此教程以 https 为例,如果你没有相关经验,请自行 Google 进行了解
42+
43+
> [!NOTE]
44+
> 免费 SSL 证书推荐使用 [httpsok-SSL证书自动续期](https://httpsok.com/p/4Qjd),一行命令,轻松搞定 SSL
45+
> 证书自动续签,支持:nginx、通配符证书、七牛云、腾讯云、阿里云、CDN、OSS、LB(负载均衡)
4246
4347
### 后端
4448

@@ -48,7 +52,7 @@ title: Docker 部署
4852

4953
将代码拉取到服务器通常采用 ssh 方式(更安全),但是你也可以选择使用 https 方式,具体方式请根据个人自行决定,如果使用 ssh
5054
方式拉取代码,请自行 Google 拉取教程
51-
55+
5256
如果使用 https 方式,你可以查看 [后端步骤 2](../summary/quick-start.md#后端)
5357

5458
2. env
@@ -292,11 +296,11 @@ title: Docker 部署
292296
2. env
293297

294298
:::: details Arco Desgin Vue
295-
299+
296300
::: caution
297301
这是一个实验性实施,它仅用作效果演示,而不是用于生产!
298302
:::
299-
303+
300304
修改 `.env.production` 中的 `VITE_API_BASE_URL` 为域名地址
301305
::::
302306

docs/guide/deploy/legacy.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,28 @@
22
title: 传统部署
33
---
44

5-
> [!IMPORTANT]
6-
> 由于传统部署方案涉及修改的地方较多且较为复杂,因此无法提供此部署教程,但您可以选择 [有偿赞助](../../sponsors.md#有偿赞助)
7-
> ,我们可以为您提供一对一专属指导和远程支持
8-
95
::: info
106
当前 FastAPI Best Architecture 线上服务器资源有限,使用【Docker + 传统】的方案进行部署,尽可能避免服务器内存溢出导致的服务中断
117
:::
8+
9+
::: tip
10+
由于传统部署方案涉及修改的地方较多且较为复杂,因此无法提供此部署教程,但您可以选择 [有偿赞助](../../sponsors.md#有偿赞助)
11+
,我们可以为您提供一对一专属指导和远程支持
12+
:::
13+
14+
::: note
15+
远程支持开始前,请准备:
16+
17+
- [x] >= 2c2g 云服务器一台
18+
- [x] 已安装 Docker 和 docker-compose
19+
- [x] 可正常 ssh
20+
- [x] 提供 root 权限
21+
- [x] 已购买并绑定域名
22+
- [x] 已解析 SSL 证书
23+
24+
:::
25+
26+
::: warning
27+
免费 SSL 证书推荐使用 [httpsok-SSL证书自动续期](https://httpsok.com/p/4Qjd),一行命令,轻松搞定 SSL
28+
证书自动续签,支持:nginx、通配符证书、七牛云、腾讯云、阿里云、CDN、OSS、LB(负载均衡)
29+
:::

docs/plugin/market.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ title: 插件市场
1717
1818
## 插件标签
1919

20-
- <Badge type="tip" text="free" /> - 免费
20+
- <Badge type="info" text="free" /> - 免费
2121
- <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)
22+
- <Badge type="tip" text="fba" /> - 仅后端
23+
- <Badge text="fba-arco" color="#4582ff"/> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui)
24+
- <Badge text="fba-vben" color="#c178ec"/> - 包含前端 [fba_ui](https://github.com/fastapi-practices/fba_ui)
2525

2626
## 官方
2727

@@ -31,8 +31,8 @@ title: 插件市场
3131
<LinkCard title="通知公告" href="https://discord.com/channels/1185035164577972344/1336557178437373984">
3232
<p>添加后台通知公告功能</p>
3333
<span>
34-
<Badge type="tip" text="free" />
35-
<Badge type="info" text="fba" />
34+
<Badge type="info" text="free" />
35+
<Badge type="tip" text="fba" />
3636
</span>
3737
</LinkCard>
3838
</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.129"
22+
"vuepress-theme-plume": "1.0.0-rc.130"
2323
},
2424
"dependencies": {
2525
"@iconify/json": "^2.2.282",

0 commit comments

Comments
 (0)