update docs

wu-clan · wu-clan · commit 46aa1257dd46 · 2025-04-15T15:52:18.000+08:00
diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts
@@ -79,7 +79,7 @@ export const myNavbar = defineNavbarConfig([
         ]
     },
     {
-        text: '插件市场',
+        text: '插件系统',
         icon: 'unjs:unplugin',
         link: '/plugin/before'
     },
diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts
@@ -68,6 +68,7 @@ export const mySidebar: ThemeSidebarMulti = {
                 { text: '前言', link: 'before' },
                 { text: '插件开发', link: 'dev' },
                 { text: '插件发布', link: 'publish' },
+                { text: '安装使用', link: 'install' },
                 { text: '插件市场', link: 'market' },
             ]
         }
diff --git a/docs/.vuepress/styles/custom.css b/docs/.vuepress/styles/custom.css
@@ -18,24 +18,6 @@
     --vp-c-brand-3: rgba(0, 148, 133, 1);
 }
 
-/* 文档式首页 name */
-.vp-home-doc-hero .container .main .heading .name {
-    font-size: 48px !important;
-}
-
-
-/* 文档式首页 text */
-.vp-home-doc-hero .container .main .heading .text {
-    font-size: 48px !important;
-}
-
-.vp-repo-card,
-.vp-link-card,
-.vp-card-wrapper {
-    /* 卡片阴影效果 */
-    box-shadow: 0 1px 2px rgba(0, 0, 0, 0.27), 0 1px 2px rgba(255, 255, 255, 0.22) !important;
-}
-
 .vp-swiper .swiper-slide-img {
     /* 轮播图图片拉伸效果 */
     object-fit: fill;
diff --git a/docs/backend/summary/quick-start.md b/docs/backend/summary/quick-start.md
@@ -66,11 +66,6 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 
    2. 插件依赖
 
-      ::: warning
-      为了实现插件 0 耦合，插件依赖并未使用 uv 进行管理。执行以下脚本后，后期如果仍需同步环境依赖，请务必使用命令：
-      `uv sync --frozen --inexact`
-      :::
-
       执行 `backend/scripts/init_plugin.py` 文件安装插件依赖
 
       ::: details 报错：ModuleNotFoundError: No module named 'backend'
@@ -94,6 +89,11 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 
       :::
 
+      ::: caution
+      为了实现插件 0 耦合，插件依赖并未使用 uv 进行管理。执行上面脚本文件后，如果后期您仍需同步环境依赖，请务必使用命令：
+      `uv sync --frozen --inexact`，否则插件依赖将被 uv 自动清理！
+      :::
+
 4. 创建数据库：`fba`，选择 utf8mb4 编码；PostgreSQL 用户可忽略编码
 5. 启动 Redis
 6. env
@@ -134,7 +134,7 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
    执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
    :::
 
-9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选" />
+9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选，三个都可以不执行" />
 
    在 `backend` 目录打开终端，执行以下命令启动 celery 相关服务
 
@@ -165,12 +165,8 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 
 11. 启动 fastapi 服务
 
-    ::: info
-    此项目默认使用 CLI 启动服务，为了方便本地调试，你仍然可以选择在 IDE 中右键运行 `run.py` 文件
-    :::
-
     ::: warning
-    如果你在项目中安装了 [应用级插件](../../plugin/dev.md#插件分类)，请务必使用 `run.py`
+    如果你在项目中安装了 [应用级插件](../../plugin/market.md)，请务必使用 `run.py`
     文件启动项目，否则，您将收到启动错误
 
     详情：[fastapi/fastapi#13372 (comment)](https://github.com/fastapi/fastapi/discussions/13372#discussioncomment-12211232)
diff --git a/docs/group.md b/docs/group.md
@@ -1,5 +1,5 @@
 ---
-title: 社区
+title: 互动
 ---
 
 您可以通过此链接 [null](https://wu-clan.github.io/homepage/) 中的任意联系方式与 fba 作者互动
diff --git a/docs/plugin/dev.md b/docs/plugin/dev.md
@@ -6,48 +6,23 @@ title: 插件开发
 
 :::: steps
 
-1. clone 最新 fba 项目到本地并配置好开发环境
-2. 根据 [插件目录结构](#插件目录结构)
-   开发插件，在开始前，开发者还需了解 [插件分类](#插件分类)、[插件路由结构](#插件路由结构)、[插件配置](#插件配置)
-3. 完成插件开发
-4. 插件分享 <Badge type="warning" text="可选" />
+1. 拉取最新的 fba 项目到本地并配置好开发环境
+2. 通过 [插件分类](#插件分类)、[插件路由结构](#插件路由结构)、[插件配置](#插件配置) 了解插件系统的运作机制
+3. 根据 [插件目录结构](#插件目录结构) 进行插件开发
+4. 完成插件开发
+5. 插件分享 <Badge type="warning" text="可选" />
 
    使用插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template)
    创建个人仓库，并将插件代码上传到个人仓库
 
    ::: warning
-   请不要将插件代码以 PR 的方式进行提交！它永远不会被接受！
+   请不要将插件代码以 PR 的方式进行提交！
    :::
 
-5. [申请发布插件](publish.md) <Badge type="warning" text="可选" />
+6. [申请发布插件](publish.md) <Badge type="warning" text="可选" />
 
 ::::
 
-### 插件目录结构
-
-::: file-tree
-
-- backend 固定目录 <Badge type="danger" text="必须" />
-    - plugin 固定目录 <Badge type="danger" text="必须" />
-        - xxx 插件名 <Badge type="danger" text="必须" />
-            - api/ 接口 <Badge type="danger" text="必须" />
-            - crud/ CRUD <Badge type="warning" text="非必须" />
-            - model/ 模型 <Badge type="warning" text="非必须" />
-                - \_\_init__.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
-                - …
-            - schema/ 数据传输 <Badge type="warning" text="非必须" />
-            - service/ 服务 <Badge type="warning" text="非必须" />
-            - utils/ 工具包 <Badge type="warning" text="非必须" />
-            - \_\_init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
-            - ...
-            - conf.py 常量配置 <Badge type="warning" text="非必须" />
-            - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
-            - README.md 插件使用说明 <Badge type="danger" text="必须" />
-            - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />；
-              如果插件需要安装依赖，则为 <Badge type="danger" text="必须" />
-
-:::
-
 ### 插件分类
 
 与插件相关的部分文档中，可能高频次出现以下两个词
@@ -110,6 +85,31 @@ tags = ''
 
 :::
 
+### 插件目录结构
+
+::: file-tree
+
+- backend 固定目录 <Badge type="danger" text="必须" />
+  - plugin 固定目录 <Badge type="danger" text="必须" />
+    - xxx 插件名 <Badge type="danger" text="必须" />
+      - api/ 接口 <Badge type="danger" text="必须" />
+      - crud/ CRUD <Badge type="warning" text="非必须" />
+      - model/ 模型 <Badge type="warning" text="非必须" />
+        - \_\_init\_\_.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
+        - …
+      - schema/ 数据传输 <Badge type="warning" text="非必须" />
+      - service/ 服务 <Badge type="warning" text="非必须" />
+      - utils/ 工具包 <Badge type="warning" text="非必须" />
+      - \_\_init\_\_.py 作为 python 包保留 <Badge type="danger" text="必须" />
+      - ...
+      - conf.py 插件配置 <Badge type="warning" text="非必须" />
+      - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
+      - README.md 插件使用说明 <Badge type="danger" text="必须" />
+      - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />；
+        如果插件需要安装依赖，则为 <Badge type="danger" text="必须" />
+
+:::
+
 ## 前端
 
 暂无此计划...
diff --git a/docs/plugin/install.md b/docs/plugin/install.md
@@ -0,0 +1,45 @@
+---
+title: 安装使用
+---
+
+插件安装方式包含以下两种：
+
+:::: tabs
+@tab 1. 手动
+
+1. 获取插件仓库源码并下载
+2. 将源码中的插件目录直接拷贝到 fba 项目对应的目录下
+
+   ::: tabs
+   @tab 后端
+
+   将插件源码 `backend/plugin/` 目录下的一级文件夹拷贝到 fba 项目 `backend/plugin/` 目录下
+
+   @tab 前端
+
+   暂无此计划...
+   :::
+
+3. 如果插件包含依赖（requirements.txt），执行 `backend/scripts/init_plugin.py` 文件安装依赖
+4. 根据插件使用说明完成安装
+
+@tab 2. 自动
+
+1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
+
+   - 下载插件 GitHub 仓库为 zip 压缩包
+
+     ::: details 示例
+     ![cg1](/images/plugin_zip.png)
+     :::
+
+   - 通过 fba 插件打包接口创建的 zip 压缩包
+
+2. 将压缩包通过 fba 插件安装接口进行安装
+3. 根据插件使用说明完成安装
+
+::::
+
+::: warning
+无论采用哪种安装方式，插件都不会实时加载，您必须重新启动 fba，插件才能被正确加载到当前系统中
+:::
diff --git a/docs/plugin/market.md b/docs/plugin/market.md
@@ -2,11 +2,6 @@
 title: 插件市场
 ---
 
-::: warning
-插件功能目前处于测试阶段，如有任何建议，请立即和我们 [反馈](https://discord.com/channels/1185035164577972344/1349951379560599572)
-吧
-:::
-
 ::: info 标签说明
 
 - <Badge type="info" text="free" /> - 免费插件
@@ -88,35 +83,3 @@ title: 插件市场
   <Card title="无">
   </Card>
 </CardGrid>
-
-## 安装
-
-插件安装方式包含以下两种：
-
-::: tabs
-@tab 1. 手动
-
-1. 获取插件仓库源码并下载，将源码中的插件目录直接拷贝到 fba 项目对应的目录下
-2. 如果插件包含依赖，执行 `backend/scripts/init_plugin.py` 文件安装依赖
-3. 根据插件使用说明完成安装
-
-@tab 2. 自动
-
-1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
-
-   - 下载插件 GitHub 仓库为 zip 压缩包
-
-     ::: details 示例
-     ![cg1](/images/plugin_zip.png)
-     :::
-
-   - 通过 fba 插件打包接口创建的 zip 压缩包
-
-2. 将压缩包通过插件安装接口进行安装
-3. 根据插件使用说明完成安装
-
-:::
-
-::: warning
-无论采用哪种安装方式，插件都不会实时加载，您必须重新启动 fba，插件才能被正确加载到当前系统中
-:::
diff --git a/docs/plugin/publish.md b/docs/plugin/publish.md
@@ -2,16 +2,12 @@
 title: 发布
 ---
 
-我们为插件打造了一个统一的 [插件市场](market.md)，用于展示和导航。如果您开发的插件与 fba 兼容，欢迎在 Discord
+我们为插件创建了一个 [插件市场](market.md)，用于展示和导航。如果您开发的插件与 fba 兼容，欢迎在 Discord
 社区的 [插件系统](https://discord.com/channels/1185035164577972344/1349951379560599572)
-频道与我们分享。我会第一时间将您的插件更新至插件市场，让更多开发者能够便捷地使用和享受。
+频道与我们分享。
 
 > [!IMPORTANT]
 > 发布插件需满足以下要求：
 >
-> - 必须提供插件 GitHub 仓库
-> - 必须在插件仓库内提供至少一种（任意）联系方式
-
-::: note
-插件数量 >= 2 的插件作者，我们将提供知识星球永久免费入驻名额
-:::
+> - 必须提供插件 GitHub 仓库地址
+> - 必须在插件仓库内提供至少一种您的（任意）联系方式

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ export const myNavbar = defineNavbarConfig([`
`79`	`79`	`]`
`80`	`80`	`},`
`81`	`81`	`{`
`82`		`- text: '插件市场',`
	`82`	`+ text: '插件系统',`
`83`	`83`	`icon: 'unjs:unplugin',`
`84`	`84`	`link: '/plugin/before'`
`85`	`85`	`},`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,7 @@ export const mySidebar: ThemeSidebarMulti = {`
`68`	`68`	`{ text: '前言', link: 'before' },`
`69`	`69`	`{ text: '插件开发', link: 'dev' },`
`70`	`70`	`{ text: '插件发布', link: 'publish' },`
	`71`	`+ { text: '安装使用', link: 'install' },`
`71`	`72`	`{ text: '插件市场', link: 'market' },`
`72`	`73`	`]`
`73`	`74`	`}`