update docs

Author: wu-clan

docs/.vuepress/layouts/Layout.vue

@@ -1,7 +1,6 @@
 <script setup>
 import BannerTop from "../components/BannerTop.vue";
 import Footer from "../components/Footer.vue";
-import PageContextMenu from 'vuepress-theme-plume/features/PageContextMenu.vue'
 import SponsorPanel from "../components/SponsorPanel.vue";
 import SponsorSidebar from "../components/SponsorSidebar.vue";
 
@@ -43,9 +42,6 @@ const showSidebarSponsorOnAsideTop = computed(() => frontmatter.value.sponsor_si
         <SponsorSidebar />
       </div>
     </template>
-    <template #doc-title-after>
-      <PageContextMenu />
-    </template>
     <template #aside-outline-after>
       <div class="custom-content">
         <SponsorPanel />

docs/.vuepress/sidebar.ts

@@ -69,13 +69,13 @@ export const mySidebar: ThemeSidebarMulti = {
             collapsed: false,
             items: [
                 { text: '前言', link: 'before' },
-                { text: '视频讲解', link: 'video' },
             ]
         },
         {
             text: '参考',
             collapsed: false,
             items: [
+                { text: '视频讲解', link: 'video' },
                 { text: '插件开发', link: 'dev' },
                 { text: '插件分享', link: 'share' },
                 { text: '插件安装', link: 'install' },

docs/.vuepress/styles/custom.css

@@ -92,6 +92,11 @@
     border-radius: 10px !important;
 }
 
+/* 首页全屏时向下的箭头 */
+.vp-sign-down {
+    color: var(--vp-c-brand-1) !important;
+}
+
 /* 公告板 */
 .vp-bulletin {
     width: 380px !important;

docs/plugin/dev.md

@@ -115,10 +115,6 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
 
 插件统一放置在 `backend/plugin` 目录下，以下是插件的目录结构
 
-::: warning
-请严格按照此结构进行插件开发，否则插件将无法完美适配 fba 内置功能
-:::
-
 ::: file-tree
 
 - xxx 插件名 <Badge type="danger" text="必须" />

docs/plugin/share.md

@@ -2,63 +2,110 @@
 title: 插件分享
 ---
 
-## 后端
+想要将插件与他人分享，您必须为此创建一个公开的 Github 仓库
 
-:::: steps
+## 后端
 
-1. 创建个人插件仓库
+::: warning 插件仓库命名规则
+`插件仓库名 == 插件名`
 
-   推荐使用插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template) 创建个人插件仓库
+假如你的插件仓库命名为 `sms`，安装此插件后，`backend/plugin` 目录下就会新增一个 `sms` 文件夹
 
-   ::: warning 插件仓库命名规则
-   `个人插件仓库名 == 插件名`
+插件总是独一无二的，不允许安装同名插件，所以在对插件进行命名时，应尽量保持其独特性，否则将导致插件冲突
+:::
 
-   假如你的个人插件仓库命名为 `sms`，安装此插件后，`backend/plugin` 目录下就会新增一个 `sms` 文件夹
+:::: steps
 
-   插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
-   :::
+1. 创建个人插件仓库
 
+   ::: details 使用 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template) 创建个人插件仓库
    ![repo](/images/plugin_template.png)
+   :::
 
 2. 上传代码
 
    将在 fba 中开发好的所有插件代码拷贝到个人插件仓库中
 
    ::: caution
-   应拷贝插件目录中的所有文件，而不是直接拷贝插件目录
+   应拷贝插件目录中的所有文件，而不是拷贝插件目录
    :::
 
 ::::
 
 ## 前端
 
-:::: steps
+::: warning 插件仓库命名规则
+`插件仓库名 == 插件名`
 
-1. 创建个人插件仓库
+假如你的个人插件仓库命名为 `sms`，安装此插件后，`apps/web-antd/src/plugins` 目录下就会新增一个 `sms` 文件夹
 
-   使用插件模板仓库 [fba_ui_plugin_template](https://github.com/fastapi-practices/fba_ui_plugin_template) 创建个人插件仓库
+插件总是独一无二的，不允许安装同名插件，所以在对插件进行命名时，应尽量保持其独特性，否则将导致插件冲突
+:::
 
-   ::: warning 插件仓库命名规则
-   `个人插件仓库名 == 插件名_ui`
+:::: steps
 
-   假如你的个人插件仓库命名为 `sms_ui`，安装此插件后，`apps/web-antd/src/plugins` 目录下就会新增一个 `sms` 文件夹
+1. 创建个人插件仓库
 
-   插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
-   :::
+   使用 [fba_ui_plugin_template](https://github.com/fastapi-practices/fba_ui_plugin_template) 创建个人插件仓库
 
 2. 上传代码
 
-   将在 fba_ui 中开发好的所有插件代码拷贝到个人插件仓库中，==仅限 Vben Admin Antd 工程=={.warning}
+   将在 fba_ui 中开发好的所有插件代码拷贝到个人插件仓库中，仅限 [Vben Admin Antd](../frontend/summary/intro.md) 工程
 
    ::: caution
-   应拷贝插件目录中的所有文件，而不是直接拷贝插件目录
+   应拷贝插件目录中的所有文件，而不是拷贝插件目录
    :::
 
 ::::
 
 ## 发布
 
-我们创建了一个简易的 [插件市场](../market.md)，用于插件展示和导航
+:::: steps
+
+1. Fork 仓库
+
+   [进入 fba 插件 github 仓库](https://github.com/fastapi-practices/plugins)，将仓库 fork 到个人账户
 
-如果您开发的插件与 fba 兼容，欢迎在 Discord
-社区的 [插件系统](https://discord.com/channels/1185035164577972344/1349951379560599572) 频道与我们分享
+2. 克隆仓库
+
+   ```shell
+   # 将地址替换为上面 fork 的仓库地址
+   git clone https://github.com/your-username/plugins.git
+   ```
+
+3. 创建分支
+
+   ```shell
+   # 注意替换 add-your-plugin
+   git checkout -b add-your-plugin
+   ```
+
+4. 扩展子模块
+
+   ```shell
+   # 注意替换 your-username、your-plugin-name
+   git submodule add https://github.com/your-username/your-plugin-name.git plugins/your-plugin-name
+   git add plugins/your-plugin-name
+   ```
+
+   ::: warning
+   所有扩展子模块必须使用 HTTPS URL，而不是 SSH URL（git@github.com）
+   :::
+
+5. 提交和推送
+
+   ```shell
+   # 注意替换 your-plugin-name
+   git commit -m "Add your-plugin-name plugin"
+   git push
+   ```
+
+6. PR
+
+   通过 GitHub 创建 PR
+
+7. 合并
+
+   fba 团队将尽快完成检查，一旦您的 PR 合并，插件将被发布到 [插件市场](../market.md)
+
+::::

docs/plugin/video.md

@@ -4,4 +4,8 @@ title: 视频讲解
 
 我们将通过此视频分别介绍 [插件开发](./dev.md)、[插件分享](./share.md)、[插件安装](install.md)
 
+::: warning
+此视频已过时，需等待重新录制
+:::
+
 @[bilibili](BV1qaoLYxEXi)