完善文档最佳实践

This commit is contained in:
wojiaoyishang
2025-01-27 20:41:22 +08:00
parent 5153daf7da
commit feed91dcd0
4 changed files with 87 additions and 7 deletions
+6 -1
View File
@@ -69,7 +69,7 @@
"plugin_description": "一个测试的插件。"
}
这个 JSON 文件中,记录了基本的插件名称与插件版本,以及插件的介绍,请确保一个插件至少包含上述的三个字段,因为这三个字段会被项目所读取并在加载成功之后展示在控制台。
这个 JSON 文件中,记录了基本的插件名称与插件版本,以及插件的介绍**在更新之后,此文件可以不存在,插件的名称默认为文件夹名。**
编写插件入口
-------------------
@@ -126,4 +126,9 @@
注意不要直接在 `__init__.py``event_init` 函数外直接写存在阻塞的代码,不然项目 Flask 将不能初始化完成。
.. note::
在编写插件的前端模板(template)时,请尽量将模板文件放在项目根目录的 `templates` 文件中,这样可以保持良好的项目架构。
当然另一种做法是像 helloworld 插件那样,直接放在插件目录的 templates 中,但是一定要做好模板名称的区分,
因为 flask 默认找模板行为是从根目录开始找的,如果根目录 templates 和插件目录的 templates 中存在的模板重名,
则会优先使用根目录 templates 的模板文件。