Skip to content

Commit 959dac6

Browse files
wu-clanwu-clan
committed
update docs
1 parent af0ba23 commit 959dac6

File tree

6 files changed

+157
-126
lines changed

6 files changed

+157
-126
lines changed

‎docs/.vuepress/navbar.ts

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
88
text: '线上演示',
99
items: [
1010
{
11-
text: 'Vben Admin Antd 完整版实施',
11+
text: 'Vben Admin Antd',
12+
icon: 'iconoir:www',
1213
link: 'https://fba.wu-clan.site/'
1314
},
1415
{
@@ -22,26 +23,30 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
2223
text: '文档',
2324
items: [
2425
{
25-
text: 'Arco Design Pro 实验性实施',
26+
text: 'Arco Design Pro',
27+
icon: 'material-symbols:docs',
2628
link: '/frontend/summary/arco',
2729
badge: { text: '已弃用', type: 'danger' }
2830
},
2931
{
30-
text: 'Vben Admin Antd 完整版实施',
32+
text: 'Vben Admin Antd',
33+
icon: 'material-symbols:docs',
3134
link: '/frontend/summary/intro'
3235
}
3336
]
3437
},
3538
{
36-
text: 'GitHub',
39+
text: '仓库地址',
3740
items: [
3841
{
39-
text: 'Arco Design Pro 实验性实施',
42+
text: 'Arco Design Pro',
43+
icon: 'mdi:github',
4044
link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui_arco',
4145
badge: { text: '已弃用', type: 'danger' }
4246
},
4347
{
44-
text: 'Vben Admin Antd 完整版实施',
48+
text: 'Vben Admin Antd',
49+
icon: 'mdi:github',
4550
link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'
4651
}
4752
]
@@ -100,15 +105,12 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
100105
},
101106
{
102107
text: '插件系统',
103-
badge: { text: 'HOT', type: 'danger' },
108+
icon: 'unjs:unplugin',
104109
link: '/plugin/before'
105110
},
106-
{
107-
text: '购买特权',
108-
link: '/pricing'
109-
},
110111
{
111112
text: '赞助',
113+
icon: 'material-icon-theme:github-sponsors',
112114
link: '/sponsors'
113115
},
114116
{
@@ -163,6 +165,10 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
163165
{
164166
text: '特权',
165167
items: [
168+
{
169+
text: '购买特权',
170+
link: '/pricing'
171+
},
166172
{
167173
text: '知识星球',
168174
icon: 'ph:planet-fill',

‎docs/plugin/before.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,5 @@ title: 前言
3434

3535
## 免责声明
3636

37-
对于付费插件作者跑路行为，我们无需承担任何责任
37+
- 对于使用恶意插件程序造成的损失，我们无需承担任何责任
38+
- 对于付费插件作者跑路行为，我们无需承担任何责任

‎docs/plugin/dev.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: 插件开发
33
---
44

5+
::: info
6+
在官方仓库中，包含多个内置插件，位于 `backend/plugin` 目录下，结合官方仓库阅读此文档，效果更佳
7+
:::
8+
59
## 后端
610

711
::: steps
@@ -137,10 +141,6 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
137141

138142
:::
139143

140-
::: warning
141-
非必要情况下，不建议引用架构中的现有方法，如果现有方法变更，则插件也必须同步变更，否则插件将不可用
142-
:::
143-
144144
## 前端
145145

146146
::: steps
@@ -174,4 +174,8 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
174174
- …
175175
- … 更多内容
176176

177-
:::
177+
:::
178+
179+
## 注意事项
180+
181+
非必要情况下，插件代码中尽量不要引用架构中的现有方法，如果架构中的现有方法发生变更，则插件也必须同步变更，否则插件将被损坏

‎docs/plugin/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ title: 插件安装
2828

2929
- 通过 fba 插件下载接口下载的 zip 压缩包
3030

31-
2. 将 zip 压缩包通过 zip 插件安装接口进行安装
31+
2. 将 zip 压缩包通过 fba zip 插件安装接口进行安装
3232
3. 根据插件说明（README.md）进行相关配置
3333
4. 重启服务
3434

3535
@tab GIT
3636

3737
1. 获取插件 git 仓库地址，理论上支持任何平台（GitHub、Gitlab、Gitee、Gitea...）
38-
2. 通过 git 插件安装接口进行安装
38+
2. 通过 fba git 插件安装接口进行安装
3939
3. 根据插件说明（README.md）进行相关配置
4040
4. 重启服务
4141

‎docs/plugin/share.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@ title: 插件分享
88

99
1. 创建个人插件仓库
1010

11-
使用插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template)
12-
创建个人插件仓库，个人插件仓库命名请遵循以下规则：
11+
推荐使用插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template) 创建个人插件仓库
1312

13+
::: warning 插件仓库命名规则
1414
`个人插件仓库名 == 插件名`
1515

16-
::: warning
17-
创建个人插件仓库的时候，应将 `backend/plugin` 目录下的插件（文件夹）名作为仓库名使用
16+
假如你的个人插件仓库命名为 `sms`，安装此插件后，`backend/plugin` 目录下就会新增一个 `sms` 文件夹
1817

1918
插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
2019
:::
@@ -23,10 +22,10 @@ title: 插件分享
2322

2423
2. 上传代码
2524

26-
将本地插件文件夹中的所有文件拷贝到个人插件仓库中
25+
将在 fba 中开发好的所有插件代码拷贝到个人插件仓库中
2726

2827
::: caution
29-
应拷贝插件文件夹中的所有文件，而不是直接拷贝插件目录
28+
应拷贝插件目录中的所有文件，而不是直接拷贝插件目录
3029
:::
3130

3231
::::
@@ -37,36 +36,29 @@ title: 插件分享
3736

3837
1. 创建个人插件仓库
3938

40-
使用插件模板仓库 [fba_ui_plugin_template](https://github.com/fastapi-practices/fba_ui_plugin_template)
41-
创建个人插件仓库，个人插件仓库命名请遵循以下规则：
39+
使用插件模板仓库 [fba_ui_plugin_template](https://github.com/fastapi-practices/fba_ui_plugin_template) 创建个人插件仓库
4240

41+
::: warning 插件仓库命名规则
4342
`个人插件仓库名 == 插件名_ui`
4443

45-
::: warning
46-
创建个人插件仓库的时候，应将 `apps/web-antd/src/plugins` 目录下的插件（文件夹）名作为仓库名使用
44+
假如你的个人插件仓库命名为 `sms_ui`，安装此插件后，`apps/web-antd/src/plugins` 目录下就会新增一个 `sms` 文件夹
4745

4846
插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
4947
:::
5048

5149
2. 上传代码
5250

53-
将本地插件文件夹中的所有文件拷贝到个人插件仓库中
51+
将在 fba_ui 中开发好的所有插件代码拷贝到个人插件仓库中，==仅限 Vben Admin Antd 工程=={.warning}
5452

5553
::: caution
56-
应拷贝插件文件夹中的所有文件，而不是直接拷贝插件目录
54+
应拷贝插件目录中的所有文件，而不是直接拷贝插件目录
5755
:::
5856

5957
::::
6058

61-
## 公开
59+
## 发布
6260

63-
我们为插件创建了一个 [插件市场](../market.md)，用于展示和导航
61+
我们创建了一个简易的 [插件市场](../market.md)，用于插件展示和导航
6462

6563
如果您开发的插件与 fba 兼容，欢迎在 Discord
6664
社区的 [插件系统](https://discord.com/channels/1185035164577972344/1349951379560599572) 频道与我们分享
67-
68-
> [!IMPORTANT]
69-
> 发布插件必须满足以下要求：
70-
>
71-
> - 提供插件 GitHub 仓库地址
72-
> - 在插件仓库内提供至少一种您的（任意）联系方式用于技术支持

0 commit comments

Comments
 (0)