Skip to content

Commit 465b017

Browse files
committed
update docs
1 parent 040c61f commit 465b017

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

docs/plugin/dev.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,17 @@ fba 会在启动前对所有插件进行解析
4949
@tab <Icon name="carbon:app" />应用级插件
5050

5151
```toml
52+
# 插件信息
53+
[plugin]
54+
# 插件名
55+
name = ''
56+
# 插件版本号
57+
version = ''
58+
# 插件描述
59+
description = ''
60+
# 插件作者
61+
author = ''
62+
5263
# 应用配置
5364
[app]
5465
# 插件路由器实例,可参考源码:backend/app/admin/api/router.py,通常默认命名为 v1
@@ -58,6 +69,17 @@ router = ['']
5869
@tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
5970

6071
```toml
72+
# 插件信息
73+
[plugin]
74+
# 插件名
75+
name = ''
76+
# 插件版本号
77+
version = ''
78+
# 插件描述
79+
description = ''
80+
# 插件作者
81+
author = ''
82+
6183
# 应用配置
6284
[app]
6385
# 此插件属于哪个 app
@@ -98,9 +120,7 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql,但我们不对
98120
- service/ 服务 <Badge type="warning" text="非必须" />
99121
- utils/ 工具包 <Badge type="warning" text="非必须" />
100122
- __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
101-
- .env.example 插件环境变量配置示例 <Badge type="warning" text="非必须" />
102-
- conf.py.example 插件独立配置示例 <Badge type="warning" text="非必须" />
103-
- … 更多其他配置,例如 enums.py... <Badge type="warning" text="非必须" />
123+
- … 更多内容,例如 enums.py... <Badge type="warning" text="非必须" />
104124
- plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
105125
- README.md 插件使用说明和您的联系方式 <Badge type="danger" text="必须" />
106126
- requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />

0 commit comments

Comments
 (0)