update docs

wu-clan · wu-clan · commit 4427f86b53f0 · 2024-12-19T21:25:41.000+08:00
diff --git a/docs/.vuepress/components/SponsorPanel.vue b/docs/.vuepress/components/SponsorPanel.vue
@@ -1,6 +1,6 @@
 <template>
     <div class="sponsor-container">
-        <!-- Gold Sponsors Section -->
+        <!-- Gold Sponsors -->
         <div class="gold-sponsors">
             <div
                     v-for="(sponsor, index) in goldSponsors"
@@ -18,7 +18,7 @@
             </div>
         </div>
 
-        <!-- Regular Sponsors Section -->
+        <!-- General Sponsors -->
         <div class="general-sponsors">
             <div
                     v-for="(sponsor, index) in generalSponsors"
@@ -72,15 +72,15 @@ const openSponsorLink = (href) => {
     display: flex;
     align-items: center;
     justify-content: center;
-    min-height: 68px;
+    min-height: 65px;
 }
 
 .sponsor-item:hover {
     border: 1px solid var(--vp-c-brand);
 }
 
 .sponsor-item.gold {
-    height: 88px;
+    height: 95px;
 }
 
 .sponsor-image {
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -14,6 +14,7 @@ export default defineUserConfig({
         ['link', {rel: 'icon', href: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg'}]
     ],
     theme: plumeTheme({
+        hostname: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/',
         blog: false,
         notes: false,
         autoFrontmatter: {
diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts
@@ -5,7 +5,7 @@ export const myNavbar = defineNavbarConfig([
         text: '演示',
         items: [
             {
-                text: 'Arco Design 版本',
+                text: 'Arco Design 实验版本',
                 link: 'https://fba.xwboy.top/'
             }
         ]
@@ -57,6 +57,11 @@ export const myNavbar = defineNavbarConfig([
                 icon: 'fa-solid:user-friends',
                 link: '/team'
             },
+            {
+                text: '申请加入',
+                icon: 'solar:pen-new-square-bold',
+                link: 'https://discord.com/channels/1185035164577972344/1319245794271956993'
+            },
         ],
     }
 ])
diff --git a/docs/.vuepress/public/images/use_this_template.png b/docs/.vuepress/public/images/use_this_template.png
diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts
@@ -4,10 +4,11 @@ import {SidebarMulti} from "vuepress-theme-plume/lib/shared";
 export const mySidebar: SidebarMulti = {
     '/guide/': [
         {
-            text: '简介',
+            text: '介绍',
             collapsed: false,
             prefix: 'summary/',
             items: [
+                {text: '简介', link: 'intro'},
                 {text: '为什么选择我们？', link: 'why'},
                 {text: '快速开始', link: 'quick-start'},
                 {text: '精简版', link: 'fsm'},
@@ -24,23 +25,23 @@ export const mySidebar: SidebarMulti = {
                 {text: 'CRUD', link: 'CRUD'},
                 {text: '事务', link: 'transaction'},
                 {text: '切换数据库', link: 'db'},
-                {text: '数据规则', link: 'data-rule'},
+                {text: '数据规则', link: 'data-rule', icon: 'mdi:planet'},
                 {text: '代码生成', link: 'code-generation'},
-                {text: '自定义异常', link: 'custom-err-msg'},
-                {text: '接口响应', link: 'response'},
+                {text: '自定义异常', link: 'custom-err-msg', icon: 'mdi:planet'},
+                {text: '接口响应', link: 'response', icon: 'mdi:planet'},
                 {text: '分页', link: 'paginate'},
-                {text: 'Celery', link: 'Celery'},
+                {text: 'Celery', link: 'Celery', icon: 'mdi:planet'},
                 {text: 'APScheduler', link: 'apscheduler'},
-                {text: '日志分析', link: 'log'},
-                {text: 'Socketio', link: 'socketio'},
+                {text: '日志分析', link: 'log', icon: 'mdi:planet'},
+                {text: 'Socketio', link: 'socketio', icon: 'mdi:planet'},
             ]
         },
         {
             text: 'Mixin',
             collapsed: false,
             prefix: 'mixin/',
             items: [
-                {text: '用户信息', link: 'user'},
+                {text: '用户信息', link: 'user', icon: 'mdi:planet'},
             ]
         },
         {
diff --git a/docs/README.md b/docs/README.md
@@ -12,7 +12,7 @@ config:
       actions:
         - theme: brand
           text: 快速开始 ->
-          link: /guide/
+          link: /guide/summary/intro
         - theme: alt
           text: 在线预览
           link: https://fba.xwboy.top
@@ -64,7 +64,7 @@ v-if="goldSponsors.length"
 mode="broadcast"
 :height="200"
 :slides-per-view="3"
-:space-between="15"
+:space-between="10"
 mousewheel
 />
 
@@ -74,7 +74,7 @@ mousewheel
 v-if="generalSponsors.length"
 :items="generalSponsors"
 mode="carousel"
-:height="200"
+:height="150"
 :slides-per-view="4"
 :space-between="10"
 :speed="5000"
diff --git a/docs/guide/other/changelog.md b/docs/guide/other/changelog.md
@@ -2,4 +2,4 @@
 title: 更新日志
 ---
 
-<h5>我们目前仍处于开发阶段，暂不提供此记录</h5>
+我们目前仍处于开发测试阶段，暂不提供此记录
diff --git a/docs/guide/reference/apscheduler.md b/docs/guide/reference/apscheduler.md
@@ -1,5 +1,5 @@
 ---
-title: Apscheduler
+title: APScheduler
 ---
 
 建设中...
diff --git a/docs/guide/reference/socketio.md b/docs/guide/reference/socketio.md
@@ -5,5 +5,3 @@ title: Socketio
 [//]: # (星球)
 
 建设中...
-
-<SponsorPanel />
diff --git a/docs/guide/summary/intro.md b/docs/guide/summary/intro.md
@@ -1,5 +1,5 @@
 ---
-title: FastAPI Best Architecture
+title: 简介
 ---
 
 > [!TIP]
@@ -60,31 +60,32 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 ## 项目结构
 
 ::: file-tree
+
 - backend/ 后端
-  - alembic/ 数据库迁移
-  - app/ 应用
-    - admin 系统后台
-      - api/ 接口
-      - crud/  CRUD
-      - model/ 模型
-      - schema/ 数据传输
-      - service/ 服务
-      - tests/ 测试
-    - generator/ 代码生成
-    - task/ 任务
-  - common/ 公共资源
-  - core/ 核心配置
-  - database/ 数据库连接
-  - log/ 日志
-  - middleware/ 中间件
-  - scripts/ 脚本
-  - sql/ SQL文件
-  - static/ 静态文件
-  - templates/ 模版文件
-  - utils/ 工具包
+    - alembic/ 数据库迁移
+    - app/ 应用
+        - admin 系统后台
+            - api/ 接口
+            - crud/ CRUD
+            - model/ 模型
+            - schema/ 数据传输
+            - service/ 服务
+            - tests/ 测试
+        - generator/ 代码生成
+        - task/ 任务
+    - common/ 公共资源
+    - core/ 核心配置
+    - database/ 数据库连接
+    - log/ 日志
+    - middleware/ 中间件
+    - scripts/ 脚本
+    - sql/ SQL文件
+    - static/ 静态文件
+    - templates/ 模版文件
+    - utils/ 工具包
 - deploy/ 服务器部署
 - ...
-:::
+  :::
 
 ## 贡献者
 
@@ -100,8 +101,6 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 
 ## 相关
 
-<RepoCard repo="wu-clan/sqlalchemy-crud-plus" />
-
 ::: tip 特别鸣谢
 本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
 驱动，感谢 [pengzhanbo](https://github.com/pengzhanbo) 对此开源项目的杰出贡献
diff --git a/docs/sponsors.md b/docs/sponsors.md
@@ -25,6 +25,11 @@ LOGO 及跳转链接
 
 您可以通过[任意渠道](https://wu-clan.github.io/homepage/)就展示位的详细事宜与 FBA 作者进行沟通
 
+|  展位  | 名额 |   费用   | 展位                               |          素材           |
+|:----:|:--:|:------:|:---------------------------------|:---------------------:|
+| 特别展位 | 3  | ￥99起/月 | 1. 首页展播展示位 <br /> 2. 文档右侧边栏大号展示位 | 赞助商名称、图片链接(16:9)、跳转链接 |
+| 普通展位 | 6  | ￥59起/月 | 1. 首页滚动展示位 <br /> 2. 文档右侧边栏小号展示位 | 赞助商名称、图片链接(16:9)、跳转链接 |
+
 ::: warning 展位赞助说明
 选择==特别展位==赞助，可帮助您的产品在 Discord 交流群以公告的形式进行推广一次
 
@@ -43,18 +48,6 @@ xxx 商品名称
 
 :::
 
-### 展位等级
-
-- 特别展位
-    - 共 3 位名额（￥99起/月）
-    - FBA 官网首页无滚动可见的特别 Logo 展示位
-    - FBA 官网右侧边栏可见的特别 Logo 展示位（开发中...）
-
-- 普通展位
-    - 共 6 位名额（￥59起/月）
-    - FBA 官网首页滚动可见的 Logo 展示位
-    - FBA 官网右侧边栏可见的 Logo 展示位（开发中...）
-
 ## 注意事项
 
 > [!CAUTION]
diff --git a/docs/team.md b/docs/team.md
@@ -1,11 +1,12 @@
 ---
 pageLayout: friends
-title: FBA 团队
-description: FBA 及其生态系统发展的背后是一个开源社区人员组成的团队，以下是部分团队成员的个人信息（以下排序随机刷新，不分先后）；如有遗漏，请通过导航栏“互动”中的任意联系方式与我们联系
+title: FastAPI Practices
+description: FastAPI Practices 及其生态系统发展的背后是一个由开源社区人员组成的团队，我们对团队中的任何成员以及所有的关注者都致以崇高的敬意；
+  我们欢迎每一位开源伙伴的加入，请查看：关于 -> 申请加入
 groups:
   -
     title: 核心团队成员
-    desc: 核心团队成员是那些积极参与维护一个或多个核心项目的人，他们对 FBA 架构做出了重大贡献
+    desc: 核心团队成员是那些积极参与维护一个或多个核心项目的人，他们对项目做出了重大贡献
     list:
       -
         name: wu-clan
@@ -36,6 +37,6 @@ groups:
     list:
   - 
     title: 社区伙伴
-    desc: 一些 FBA 的社区成员让这里变得更加丰富多彩，有必要在此特别提及。我们与这些主要合作伙伴建立了更加亲密的关系，经常与他们就即将到来的功能和新闻展开协作
+    desc: 一些 FastAPI Practices 的社区成员让这里变得更加丰富多彩，有必要在此特别提及。我们与这些主要合作伙伴建立了更加亲密的关系，经常与他们就即将到来的功能和新闻展开协作
     list:
 ---
diff --git a/package.json b/package.json
@@ -19,7 +19,6 @@
   },
   "dependencies": {
     "@iconify/json": "^2.2.282",
-    "@vuepress-plume/plugin-search": "1.0.0-rc.121",
     "mermaid": "^11.4.1",
     "swiper": "^11.1.15"
   }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ export const myNavbar = defineNavbarConfig([`
`5`	`5`	`text: '演示',`
`6`	`6`	`items: [`
`7`	`7`	`{`
`8`		`- text: 'Arco Design 版本',`
	`8`	`+ text: 'Arco Design 实验版本',`
`9`	`9`	`link: 'https://fba.xwboy.top/'`
`10`	`10`	`}`
`11`	`11`	`]`
`@@ -57,6 +57,11 @@ export const myNavbar = defineNavbarConfig([`
`57`	`57`	`icon: 'fa-solid:user-friends',`
`58`	`58`	`link: '/team'`
`59`	`59`	`},`
	`60`	`+ {`
	`61`	`+ text: '申请加入',`
	`62`	`+ icon: 'solar:pen-new-square-bold',`
	`63`	`+ link: 'https://discord.com/channels/1185035164577972344/1319245794271956993'`
	`64`	`+ },`
`60`	`65`	`],`
`61`	`66`	`}`
`62`	`67`	`])`