Skip to content

Commit 65467b9

Browse files
committed
update docs
1 parent 209223d commit 65467b9

38 files changed

+1525
-1963
lines changed

docs/.vuepress/components/BannerTop.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ updateDocumentClass();
4141

4242
<style>
4343
html:not(.banner-dismissed) {
44-
--vp-layout-top-height: 60px;
44+
--vp-layout-top-height: 50px;
4545
}
4646
</style>
4747

docs/.vuepress/components/PluginMarket.vue

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,21 @@
3030
v-if="item.free?.valueOf() === false"
3131
class="price-corner-tag paid"
3232
>
33-
<span class="price-corner-text">付费</span>
33+
<span class="price-corner-text">Not Free</span>
3434
</div>
3535
</div>
3636
<div class="card-content">
3737
<div class="card-title-row">
38+
<img v-if="item.logo" :src="item.logo" class="logo" />
3839
<h3 class="card-title">{{ item.title }}</h3>
3940
<div class="card-title-link">
4041
<a
41-
v-if="item.link"
4242
:href="item.link"
43-
class="no-external-icon"
4443
target="_blank"
4544
rel="noopener noreferrer"
46-
aria-label="GitHub仓库"
4745
@click.stop
4846
/>
49-
<span v-else class="built-in-label-inline">内置</span>
47+
<span class="label-inline">{{ item.label || '内置' }}</span>
5048
</div>
5149
</div>
5250
<p class="card-description">{{ item.description }}</p>
@@ -70,9 +68,11 @@ export interface PluginItem {
7068
icon: string
7169
title: string
7270
description: string
71+
label?: string
7372
tags: string[]
7473
link?: string
7574
image?: string
75+
logo: string
7676
free?: boolean
7777
}
7878
@@ -219,23 +219,20 @@ const handleCardClick = (item: PluginItem) => {
219219
font-size: 1.5rem
220220
}
221221
222-
.built-in-label-inline {
222+
.label-inline {
223223
font-size: 0.75rem;
224-
color: var(--vp-c-text-2);
225224
padding: 0.1rem 0.4rem;
226225
border-radius: 4px;
227226
border: 1px solid var(--vp-c-border);
228-
background: rgba(255, 255, 255, 0.1);
227+
background-color: var(--vp-c-bg-soft);
229228
white-space: nowrap;
230-
font-weight: 500;
231229
}
232230
233231
.card-description {
234232
color: var(--vp-c-text-2);
235-
font-size: 0.75rem;
236-
line-height: 1.8;
237-
margin: 0 0 1rem;
238-
flex-grow: 1;
233+
font-size: 0.8rem;
234+
margin-top: 0.5rem;
235+
flex: 1
239236
}
240237
241238
.card-tags {
@@ -244,15 +241,21 @@ const handleCardClick = (item: PluginItem) => {
244241
gap: 0.2rem;
245242
}
246243
244+
.logo {
245+
width: 32px;
246+
height: 32px;
247+
border-radius: 8px;
248+
border: 1px solid var(--vp-c-border);
249+
}
250+
247251
.price-corner-tag {
248252
position: absolute;
249253
top: 0;
250254
right: 0;
251-
color: #fff;
252-
padding: 0.3rem 0.6rem;
255+
color: white;
256+
padding: 0 0.6rem;
253257
font-size: 0.75rem;
254258
font-weight: 500;
255-
line-height: 1;
256259
border-bottom-left-radius: 4px;
257260
transform: translate(1px, -1px);
258261
z-index: 1;

docs/.vuepress/components/SponsorHome.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</section>
99
<section v-else id="special-spsr">
1010
<span class="no-brand">
11-
<a href="/fastapi_best_architecture_docs/sponsors.html" target="_blank">特别赞助位目前空缺 - 现在咨询 💬</a>
11+
<a href="/fastapi_best_architecture_docs/sponsors.html" target="_blank">特别赞助位目前空缺 - 立即咨询 💬</a>
1212
</span>
1313
</section>
1414
</template>

docs/.vuepress/data/plugin.ts

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,93 +5,114 @@ export const pluginItems: PluginItem[] = [
55
icon: "fa6-regular:file-code",
66
title: "代码生成",
77
description: "生成通用业务代码(仅后端工程)",
8-
tags: ["mysql", "pgsql", "后端"]
8+
tags: ["mysql", "pgsql", "后端"],
9+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
910
},
1011
{
1112
icon: "fe:notice-active",
1213
title: "通知公告",
1314
description: "发布系统内部通知、公告",
14-
tags: ["mysql", "pgsql", "后端"]
15+
tags: ["mysql", "pgsql", "后端"],
16+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
1517
},
1618
{
1719
icon: "fluent-mdl2:dictionary",
1820
title: "数据字典",
1921
description: "通常用于约束前端工程数据展示",
20-
tags: ["mysql", "pgsql", "后端"]
22+
tags: ["mysql", "pgsql", "后端"],
23+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
2124
},
2225
{
2326
icon: "icon-park-outline:config",
2427
title: "参数配置",
2528
description: "通常用于前端工程数据展示",
26-
tags: ["mysql", "pgsql", "后端"]
29+
tags: ["mysql", "pgsql", "后端"],
30+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
2731
},
2832
{
2933
icon: "logos:oauth",
3034
title: "OAuth 2.0",
3135
description: "通过 OAuth 2.0 的方式登录系统",
32-
tags: ["mysql", "pgsql", "后端"]
36+
tags: ["mysql", "pgsql", "后端"],
37+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
3338
},
3439
{
3540
icon: "charm:shield-keyhole",
3641
title: "Casbin-RBAC",
3742
description: "基于 Casbin 实现的 RBAC 权限",
43+
label: '官方',
3844
tags: ["mysql", "pgsql", "后端"],
3945
link: "https://github.com/fastapi-practices/casbin_rbac",
40-
image: "https://avatars.githubusercontent.com/u/27810343?s=200&v=4"
46+
image: "https://avatars.githubusercontent.com/u/27810343?s=200&v=4",
47+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
4148
},
4249
{
4350
icon: "codicon:mcp",
4451
title: "MCP 服务器管理",
4552
description: "提供了 MCP 服务器管理功能,并添加了可调用 MCP 的 AI 聊天接口",
53+
label: '官方',
4654
tags: ["mysql", "pgsql", "后端"],
4755
link: "https://github.com/fastapi-practices/mcp",
56+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
4857
},
4958
{
5059
icon: "ant-design:aliyun-outlined",
5160
title: "阿里云 oss",
5261
description: "阿里云 oss 文件上传",
62+
label: '官方',
5363
tags: ["mysql", "pgsql", "后端"],
5464
link: "https://github.com/fastapi-practices/aliyun_oss",
55-
image: "https://registry.npmmirror.com/@lobehub/icons-static-png/latest/files/dark/alibabacloud-color.png"
65+
image: "https://registry.npmmirror.com/@lobehub/icons-static-png/latest/files/dark/alibabacloud-color.png",
66+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png'
5667
},
5768
{
5869
icon: "material-symbols:token-outline",
5970
title: "配置下发",
6071
description: "将 env 等配置信息通过数据库进行管理",
72+
label: '第三方',
6173
tags: ["mysql", "后端", "前端"],
62-
link: "https://github.com/dividduang/option"
74+
link: "https://github.com/dividduang/option",
75+
logo: 'https://avatars.githubusercontent.com/u/110005582?v=4',
6376
},
6477
{
6578
icon: "ant-design:wechat-work-outlined",
6679
title: "企微 bot 定时任务",
6780
description: "定时调用企业微信群聊机器人发送消息",
81+
label: '第三方',
6882
tags: ["mysql", "后端"],
6983
link: "https://github.com/dividduang/wecom-task",
70-
image: "https://wwcdn.weixin.qq.com/node/wework/images/202201062104.366e5ee28e.png"
84+
image: "https://wwcdn.weixin.qq.com/node/wework/images/202201062104.366e5ee28e.png",
85+
logo: 'https://avatars.githubusercontent.com/u/110005582?v=4',
7186
},
7287
{
7388
icon: "arcticons:sso-plus",
7489
title: "Casdoor SSO",
7590
description: "通过 Casdoor 实现 SSO 单点登录集成",
91+
label: '官方',
7692
tags: ["mysql", "pgsql", "后端"],
7793
link: "/fastapi_best_architecture_docs/planet.html",
7894
image: "https://casdoor.org/zh/img/casdoor.png",
95+
logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png',
7996
free: false
8097
},
8198
{
8299
icon: "material-icon-theme:authors",
83100
title: "LDAP",
84101
description: "通过 LDAP 登录系统并授权",
102+
label: '第三方',
85103
tags: ["mysql", "pgsql", "后端"],
86104
link: "https://github.com/dividduang/ldap_auth",
87-
image: "https://www.cleo.com/sites/default/files/2023-12/ldap-integration.png"
105+
image: "https://www.cleo.com/sites/default/files/2023-12/ldap-integration.png",
106+
logo: 'https://avatars.githubusercontent.com/u/110005582?v=4',
88107
},
89108
{
90109
icon: "fa-solid:sms",
91110
title: "腾讯云 sms",
92111
description: "通过腾讯云短信服务发送短信验证码",
112+
label: '第三方',
93113
tags: ["mysql", "pgsql", "后端"],
94114
link: "https://github.com/RanY-Luck/fba_plugin_sms",
95-
image: "https://registry.npmmirror.com/@lobehub/icons-static-png/latest/files/dark/tencentcloud-color.png"
115+
image: "https://registry.npmmirror.com/@lobehub/icons-static-png/latest/files/dark/tencentcloud-color.png",
116+
logo: 'https://avatars.githubusercontent.com/u/67427627?v=4',
96117
},
97118
]

docs/.vuepress/navbar.ts

Lines changed: 70 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ export const myNavbar = defineNavbarConfig([
1818
items: [
1919
{
2020
text: 'Arco Design Pro 实验性实施',
21-
link: '/frontend/arco',
21+
link: '/frontend/summary/arco',
2222
badge: { text: '已弃用', type: 'danger' }
2323
},
2424
{
2525
text: 'Vben Admin Antd 完整版实施',
26-
link: '/frontend/intro'
26+
link: '/frontend/summary/intro'
2727
}
2828
]
2929
},
@@ -105,7 +105,7 @@ export const myNavbar = defineNavbarConfig([
105105
},
106106
{
107107
text: '插件系统',
108-
badge: { text: 'NEW' },
108+
badge: { text: 'HOT', type: 'danger' },
109109
link: '/plugin/before'
110110
},
111111
{
@@ -117,32 +117,84 @@ export const myNavbar = defineNavbarConfig([
117117
link: '/sponsors'
118118
},
119119
{
120-
text: '互动',
121-
link: '/group'
120+
text: '生态系统',
121+
items: [
122+
{
123+
text: '资源',
124+
items: [
125+
{
126+
text: '开源项目',
127+
icon: 'mdi:github',
128+
link: '/opensource'
129+
},
130+
{
131+
text: '技术栈',
132+
icon: 'material-symbols:stack',
133+
link: '/stack'
134+
},
135+
{
136+
text: '用户登记',
137+
icon: 'mdi:user-check',
138+
link: '/users'
139+
},
140+
]
141+
},
142+
{
143+
text: '互动',
144+
items: [
145+
{
146+
text: '交流群',
147+
icon: 'ic:baseline-wechat',
148+
link: '/group'
149+
},
150+
{
151+
text: '作者主页',
152+
icon: 'streamline-plump:browser-website-1-remix',
153+
link: 'https://wu-clan.github.io/homepage'
154+
},
155+
{
156+
text: 'Github 问题',
157+
icon: 'codicon:issues',
158+
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/issues'
159+
},
160+
{
161+
text: 'Github 讨论',
162+
icon: 'mdi:discussion',
163+
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/discussions'
164+
},
165+
]
166+
},
167+
{
168+
text: '特权',
169+
items: [
170+
{
171+
text: '知识星球',
172+
icon: 'ph:planet-fill',
173+
link: '/planet'
174+
},
175+
{
176+
text: '视频课程',
177+
badge: { text: '限时开放', type: 'warning' },
178+
icon: 'ri:bilibili-fill',
179+
link: 'https://space.bilibili.com/284237214/lists'
180+
},
181+
]
182+
}
183+
]
122184
},
123185
{
124186
text: '关于',
125187
items: [
126188
{
127-
text: '谁在使用',
128-
icon: 'mdi:user-check',
129-
link: '/who'
189+
text: '常见问题',
190+
icon: 'healthicons:question',
191+
link: '/questions.md'
130192
},
131193
{
132194
text: '维护团队',
133195
icon: 'fa-solid:user-friends',
134196
link: '/team'
135197
},
136-
{
137-
text: '加入团队',
138-
icon: 'mingcute:user-add-2-fill',
139-
link: '/join'
140-
},
141-
{
142-
text: '知识星球',
143-
icon: 'ph:planet-fill',
144-
link: '/planet'
145-
},
146198
],
147199
}
148200
])

docs/.vuepress/sidebar.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export const mySidebar: ThemeSidebarMulti = {
2828
collapsed: false,
2929
prefix: 'reference/',
3030
items: [
31-
{ text: '配置', link: 'config'},
32-
{ text: 'CLI', link: 'cli'},
31+
{ text: '配置', link: 'config' },
32+
{ text: 'CLI', link: 'cli' },
3333
{ text: '模型', link: 'model' },
3434
{ text: 'Schema', link: 'schema' },
3535
{ text: '路由', link: 'router' },
@@ -91,22 +91,24 @@ export const mySidebar: ThemeSidebarMulti = {
9191
text: '市场',
9292
collapsed: false,
9393
items: [
94-
{ text: '插件市场', link: '/market' },
94+
{ text: '插件市场', badge: { text: 'HOT', type: 'danger' }, link: '/market' },
9595
]
9696
}
9797
],
9898
'/frontend/': [
9999
{
100-
text: '参考',
100+
text: '介绍',
101101
collapsed: false,
102+
prefix: 'summary/',
102103
items: [
103-
{ text: '介绍', link: 'intro' },
104+
{ text: '简介', link: 'intro' },
104105
{ text: '快速开始', link: 'quick-start' },
105106
]
106107
},
107108
{
108109
text: '部署',
109110
collapsed: false,
111+
prefix: 'deploy/',
110112
items: [
111113
{ text: 'Docker', link: 'docker' },
112114
{ text: '传统', link: 'legacy' },

0 commit comments

Comments
 (0)