update docs

Author: wu-clan

docs/backend/reference/router.md

@@ -12,27 +12,27 @@ fba 中的路由遵循 Restful API 规范
 
 ::: file-tree
 
-- backend 后端
-    - app 应用
-        - xxx 自定义应用 <Badge type="warning" text="包含子包" />
-            - api 接口
+- backend # 后端
+    - app # 应用
+        - xxx # 自定义应用 <Badge type="warning" text="包含子包" />
+            - api # 接口
                 - v1
-                    - xxx 子包
-                        - __init__.py 在此文件内注册子包内 xxx.py 文件中的路由
+                    - xxx # 子包
+                        - __init__.py # 在此文件内注册子包内 xxx.py 文件中的路由
                         - xxx.py
                         - ...
                 - __init__.py
-                - router.py 在此文件内注册所有子包 __init__.py 文件中的路由
-        - xxx 自定义应用 <Badge type="warning" text="不包含子包" />
-            - api 接口
+                - router.py # 在此文件内注册所有子包 __init__.py 文件中的路由
+        - xxx # 自定义应用 <Badge type="warning" text="不包含子包" />
+            - api # 接口
                 - v1
-                    - __init__.py 不做任何操作
+                    - __init__.py # 不做任何操作
                     - xxx.py
                     - ...
                 - __init__.py
-                - router.py 在此文件内注册所有 xxx.py 文件中的路由
+                - router.py # 在此文件内注册所有 xxx.py 文件中的路由
     - __init__.py
-    - router.py 在此文件内注册所有 app 目录下 router.py 文件中的路由
+    - router.py # 在此文件内注册所有 app 目录下 router.py 文件中的路由
 
 :::
 

docs/backend/summary/intro.md

@@ -61,35 +61,35 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 
 ::: file-tree
 
-- backend 后端
-    - alembic/ 数据库迁移
-    - app 应用
-        - admin/ 系统后台
-            - api/ 接口
-            - crud/ CRUD
-            - model 模型
-                - __init__.py 必须在此文件内导入所有模型类
+- backend # 后端
+    - alembic/ # 数据库迁移
+    - app # 应用
+        - admin/ # 系统后台
+            - api/ # 接口
+            - crud/ # CRUD
+            - model # 模型
+                - __init__.py # 必须在此文件内导入所有模型类
                 - …
-            - schema/ 数据传输
-            - service/ 服务
-            - tests/ 单元测试
-        - task/ 任务
+            - schema/ # 数据传输
+            - service/ # 服务
+            - tests/ # 单元测试
+        - task/ # 任务
         - …
-    - common/ 公共资源
-    - core/ 核心配置
-    - database/ 数据库连接
-    - langs/ 国际化语言包
-    - log/ 日志
-    - middleware/ 中间件
-    - plugin 插件
-        - code_generator/ 代码生成
+    - common/ # 公共资源
+    - core/ # 核心配置
+    - database/ # 数据库连接
+    - langs/ # 国际化语言包
+    - log/ # 日志
+    - middleware/ # 中间件
+    - plugin # 插件
+        - code_generator/ # 代码生成
         - …
-    - scripts/ 脚本
-    - sql/ SQL 文件
-    - static/ 静态文件
-    - templates/ 模版文件
-    - utils/ 工具包
-- deploy/ 服务器部署
+- scripts/ # 脚本
+- sql/ # SQL 文件
+- static/ # 静态文件
+- templates/ # 模版文件
+- utils/ # 工具包
+- deploy/ # 服务器部署
 - …
 
 :::

docs/plugin/dev.md

@@ -58,29 +58,29 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
 
 ::: file-tree
 
-- xxx 插件名 <Badge type="danger" text="必须" />
-    - api/ 接口 <Badge type="danger" text="必须" />
-    - crud/ CRUD
-    - model 模型
-        - __init__.py 在此文件内导入所有模型类 <Badge type="danger" text="目录存在则必须" />
+- xxx # 插件名 <Badge type="danger" text="必须" />
+    - api/ # 接口 <Badge type="danger" text="必须" />
+    - crud/ # CRUD
+    - model # 模型
+        - __init__.py # 在此文件内导入所有模型类 <Badge type="danger" text="目录存在则必须" />
         - …
-    - schema/ 数据传输
-    - service/ 服务
-    - sql 如果插件需要执行 SQL 则建议
+    - schema/ # 数据传输
+    - service/ # 服务
+    - sql # 如果插件需要执行 SQL 则建议
         - mysql
-            - destroy.sql 自增 id 销毁（卸载自动执行）
-            - destroy_snowflake.sql 雪花 id 销毁
-            - init.sql 自增 id 初始化（安装自动执行）
-            - init_snowflake.sql 雪花 id 初始化
+            - destroy.sql # 自增 id 销毁（卸载自动执行）
+            - destroy_snowflake.sql # 雪花 id 销毁
+            - init.sql # 自增 id 初始化（安装自动执行）
+            - init_snowflake.sql # 雪花 id 初始化
         - postgresql
-            - ... 文件命名与 mysql 相同
-    - utils/ 工具包
-    - .env.example 环境变量
-    - __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
-    - … 更多内容，例如 enums.py...
-    - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
-    - README.md 插件使用说明和您的联系方式 <Badge type="danger" text="必须" />
-    - requirements.txt 依赖包文件
+            - ... # 文件命名与 mysql 相同
+    - utils/ # 工具包
+    - .env.example # 环境变量
+    - __init__.py # 作为 python 包保留 <Badge type="danger" text="必须" />
+    - … # 更多内容，例如 enums.py...
+    - plugin.toml # 插件配置文件 <Badge type="danger" text="必须" />
+    - README.md # 插件使用说明和您的联系方式 <Badge type="danger" text="必须" />
+    - requirements.txt # 依赖包文件
 
 :::
 
@@ -259,23 +259,23 @@ IDE 获取全局配置键入提示，这是必需的，相反，你们将无法
 
 ::: file-tree
 
-- xxx 插件名
-    - api 接口
+- xxx # 插件名
+    - api # 接口
         - index.ts
-    - langs 多语言
+    - langs # 多语言
         - en-US
             - 插件名.json
         - zh-CN
             - 插件名.json
-    - public 
-        - images/ 页面效果预览
-    - routes 路由
+    - public
+        - images/ # 页面效果预览
+    - routes # 路由
         - index.ts
-    - views 视图
+    - views # 视图
         - index.vue
         - …
-    - … 更多内容
-    - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
+    - … # 更多内容
+    - plugin.toml # 插件配置文件 <Badge type="danger" text="必须" />
 
 :::
 
@@ -305,4 +305,4 @@ tags = ['']
 
 ::: caution
 非必要情况下，插件代码中尽量不要引用架构中的现有方法，如果架构中的现有方法发生变更，则插件也必须同步变更，否则插件将被损坏
-:::
+:::