Skip to content

Commit 4427f86

Browse files
wu-clanwu-clan
committed
update docs
1 parent 2ed7988 commit 4427f86

File tree

14 files changed

+479
-485
lines changed

14 files changed

+479
-485
lines changed

‎docs/.vuepress/components/SponsorPanel.vue

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<template>
22
<div class="sponsor-container">
3-
<!-- Gold Sponsors Section -->
3+
<!-- Gold Sponsors -->
44
<div class="gold-sponsors">
55
<div
66
v-for="(sponsor, index) in goldSponsors"
@@ -18,7 +18,7 @@
1818
</div>
1919
</div>
2020

21-
<!-- Regular Sponsors Section -->
21+
<!-- General Sponsors -->
2222
<div class="general-sponsors">
2323
<div
2424
v-for="(sponsor, index) in generalSponsors"
@@ -72,15 +72,15 @@ const openSponsorLink = (href) => {
7272
display: flex;
7373
align-items: center;
7474
justify-content: center;
75-
min-height: 68px;
75+
min-height: 65px;
7676
}
7777
7878
.sponsor-item:hover {
7979
border: 1px solid var(--vp-c-brand);
8080
}
8181
8282
.sponsor-item.gold {
83-
height: 88px;
83+
height: 95px;
8484
}
8585
8686
.sponsor-image {

‎docs/.vuepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export default defineUserConfig({
1414
['link', {rel: 'icon', href: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg'}]
1515
],
1616
theme: plumeTheme({
17+
hostname: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/',
1718
blog: false,
1819
notes: false,
1920
autoFrontmatter: {

‎docs/.vuepress/navbar.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export const myNavbar = defineNavbarConfig([
55
text: '演示',
66
items: [
77
{
8-
text: 'Arco Design 版本',
8+
text: 'Arco Design 实验版本',
99
link: 'https://fba.xwboy.top/'
1010
}
1111
]
@@ -57,6 +57,11 @@ export const myNavbar = defineNavbarConfig([
5757
icon: 'fa-solid:user-friends',
5858
link: '/team'
5959
},
60+
{
61+
text: '申请加入',
62+
icon: 'solar:pen-new-square-bold',
63+
link: 'https://discord.com/channels/1185035164577972344/1319245794271956993'
64+
},
6065
],
6166
}
6267
])

‎docs/.vuepress/public/images/use_this_template.png

10.4 KB
Loading

‎docs/.vuepress/sidebar.ts

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ import {SidebarMulti} from "vuepress-theme-plume/lib/shared";
44
export const mySidebar: SidebarMulti = {
55
'/guide/': [
66
{
7-
text: '简介',
7+
text: '介绍',
88
collapsed: false,
99
prefix: 'summary/',
1010
items: [
11+
{text: '简介', link: 'intro'},
1112
{text: '为什么选择我们？', link: 'why'},
1213
{text: '快速开始', link: 'quick-start'},
1314
{text: '精简版', link: 'fsm'},
@@ -24,23 +25,23 @@ export const mySidebar: SidebarMulti = {
2425
{text: 'CRUD', link: 'CRUD'},
2526
{text: '事务', link: 'transaction'},
2627
{text: '切换数据库', link: 'db'},
27-
{text: '数据规则', link: 'data-rule'},
28+
{text: '数据规则', link: 'data-rule', icon: 'mdi:planet'},
2829
{text: '代码生成', link: 'code-generation'},
29-
{text: '自定义异常', link: 'custom-err-msg'},
30-
{text: '接口响应', link: 'response'},
30+
{text: '自定义异常', link: 'custom-err-msg', icon: 'mdi:planet'},
31+
{text: '接口响应', link: 'response', icon: 'mdi:planet'},
3132
{text: '分页', link: 'paginate'},
32-
{text: 'Celery', link: 'Celery'},
33+
{text: 'Celery', link: 'Celery', icon: 'mdi:planet'},
3334
{text: 'APScheduler', link: 'apscheduler'},
34-
{text: '日志分析', link: 'log'},
35-
{text: 'Socketio', link: 'socketio'},
35+
{text: '日志分析', link: 'log', icon: 'mdi:planet'},
36+
{text: 'Socketio', link: 'socketio', icon: 'mdi:planet'},
3637
]
3738
},
3839
{
3940
text: 'Mixin',
4041
collapsed: false,
4142
prefix: 'mixin/',
4243
items: [
43-
{text: '用户信息', link: 'user'},
44+
{text: '用户信息', link: 'user', icon: 'mdi:planet'},
4445
]
4546
},
4647
{

‎docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ config:
1212
actions:
1313
- theme: brand
1414
text: 快速开始 ->
15-
link: /guide/
15+
link: /guide/summary/intro
1616
- theme: alt
1717
text: 在线预览
1818
link: https://fba.xwboy.top
@@ -64,7 +64,7 @@ v-if="goldSponsors.length"
6464
mode="broadcast"
6565
:height="200"
6666
:slides-per-view="3"
67-
:space-between="15"
67+
:space-between="10"
6868
mousewheel
6969
/>
7070

@@ -74,7 +74,7 @@ mousewheel
7474
v-if="generalSponsors.length"
7575
:items="generalSponsors"
7676
mode="carousel"
77-
:height="200"
77+
:height="150"
7878
:slides-per-view="4"
7979
:space-between="10"
8080
:speed="5000"

‎docs/guide/other/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
title: 更新日志
33
---
44

5-
<h5>我们目前仍处于开发阶段，暂不提供此记录</h5>
5+
我们目前仍处于开发测试阶段，暂不提供此记录

‎docs/guide/reference/apscheduler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Apscheduler
2+
title: APScheduler
33
---
44

55
建设中...

‎docs/guide/reference/socketio.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,3 @@ title: Socketio
55
[//]: # (星球)
66

77
建设中...
8-
9-
<SponsorPanel />

‎docs/guide/README.md renamed to ‎docs/guide/summary/intro.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: FastAPI Best Architecture
2+
title: 简介
33
---
44

55
> [!TIP]
@@ -60,31 +60,32 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
6060
## 项目结构
6161

6262
::: file-tree
63+
6364
- backend/ 后端
64-
- alembic/ 数据库迁移
65-
- app/ 应用
66-
- admin 系统后台
67-
- api/ 接口
68-
- crud/ CRUD
69-
- model/ 模型
70-
- schema/ 数据传输
71-
- service/ 服务
72-
- tests/ 测试
73-
- generator/ 代码生成
74-
- task/ 任务
75-
- common/ 公共资源
76-
- core/ 核心配置
77-
- database/ 数据库连接
78-
- log/ 日志
79-
- middleware/ 中间件
80-
- scripts/ 脚本
81-
- sql/ SQL文件
82-
- static/ 静态文件
83-
- templates/ 模版文件
84-
- utils/ 工具包
65+
- alembic/ 数据库迁移
66+
- app/ 应用
67+
- admin 系统后台
68+
- api/ 接口
69+
- crud/ CRUD
70+
- model/ 模型
71+
- schema/ 数据传输
72+
- service/ 服务
73+
- tests/ 测试
74+
- generator/ 代码生成
75+
- task/ 任务
76+
- common/ 公共资源
77+
- core/ 核心配置
78+
- database/ 数据库连接
79+
- log/ 日志
80+
- middleware/ 中间件
81+
- scripts/ 脚本
82+
- sql/ SQL文件
83+
- static/ 静态文件
84+
- templates/ 模版文件
85+
- utils/ 工具包
8586
- deploy/ 服务器部署
8687
- ...
87-
:::
88+
:::
8889

8990
## 贡献者
9091

@@ -100,8 +101,6 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
100101

101102
## 相关
102103

103-
<RepoCard repo="wu-clan/sqlalchemy-crud-plus" />
104-
105104
::: tip 特别鸣谢
106105
本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
107106
驱动，感谢 [pengzhanbo](https://github.com/pengzhanbo) 对此开源项目的杰出贡献

‎docs/sponsors.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ LOGO 及跳转链接
2525

2626
您可以通过[任意渠道](https://wu-clan.github.io/homepage/)就展示位的详细事宜与 FBA 作者进行沟通
2727

28+
| 展位 | 名额 | 费用 | 展位 | 素材 |
29+
|:----:|:--:|:------:|:---------------------------------|:---------------------:|
30+
| 特别展位 | 3 | ￥99起/月 | 1. 首页展播展示位 <br /> 2. 文档右侧边栏大号展示位 | 赞助商名称、图片链接(16:9)、跳转链接 |
31+
| 普通展位 | 6 | ￥59起/月 | 1. 首页滚动展示位 <br /> 2. 文档右侧边栏小号展示位 | 赞助商名称、图片链接(16:9)、跳转链接 |
32+
2833
::: warning 展位赞助说明
2934
选择==特别展位==赞助，可帮助您的产品在 Discord 交流群以公告的形式进行推广一次
3035

@@ -43,18 +48,6 @@ xxx 商品名称
4348

4449
:::
4550

46-
### 展位等级
47-
48-
- 特别展位
49-
- 共 3 位名额（￥99起/月）
50-
- FBA 官网首页无滚动可见的特别 Logo 展示位
51-
- FBA 官网右侧边栏可见的特别 Logo 展示位（开发中...）
52-
53-
- 普通展位
54-
- 共 6 位名额（￥59起/月）
55-
- FBA 官网首页滚动可见的 Logo 展示位
56-
- FBA 官网右侧边栏可见的 Logo 展示位（开发中...）
57-
5851
## 注意事项
5952

6053
> [!CAUTION]

‎docs/team.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
pageLayout: friends
3-
title: FBA 团队
4-
description: FBA 及其生态系统发展的背后是一个开源社区人员组成的团队，以下是部分团队成员的个人信息（以下排序随机刷新，不分先后）；如有遗漏，请通过导航栏“互动”中的任意联系方式与我们联系
3+
title: FastAPI Practices
4+
description: FastAPI Practices 及其生态系统发展的背后是一个由开源社区人员组成的团队，我们对团队中的任何成员以及所有的关注者都致以崇高的敬意；
5+
我们欢迎每一位开源伙伴的加入，请查看：关于 -> 申请加入
56
groups:
67
-
78
title: 核心团队成员
8-
desc: 核心团队成员是那些积极参与维护一个或多个核心项目的人，他们对 FBA 架构做出了重大贡献
9+
desc: 核心团队成员是那些积极参与维护一个或多个核心项目的人，他们对项目做出了重大贡献
910
list:
1011
-
1112
name: wu-clan
@@ -36,6 +37,6 @@ groups:
3637
list:
3738
-
3839
title: 社区伙伴
39-
desc: 一些 FBA 的社区成员让这里变得更加丰富多彩，有必要在此特别提及。我们与这些主要合作伙伴建立了更加亲密的关系，经常与他们就即将到来的功能和新闻展开协作
40+
desc: 一些 FastAPI Practices 的社区成员让这里变得更加丰富多彩，有必要在此特别提及。我们与这些主要合作伙伴建立了更加亲密的关系，经常与他们就即将到来的功能和新闻展开协作
4041
list:
4142
---

‎package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
},
2020
"dependencies": {
2121
"@iconify/json": "^2.2.282",
22-
"@vuepress-plume/plugin-search": "1.0.0-rc.121",
2322
"mermaid": "^11.4.1",
2423
"swiper": "^11.1.15"
2524
}

0 commit comments

Comments
 (0)