docs: 末尾添加说明文档列表

elecV2 · Nov 2, 2022 · 34047c8 · 34047c8
1 parent f347ebe
commit 34047c8
Show file tree

Hide file tree

Showing 11 changed files with 155 additions and 15 deletions.
diff --git a/docs/01-overview.md b/docs/01-overview.md
@@ -310,4 +310,18 @@ TG 交流群: https://t.me/elecV2G
 - [vue-draggable-resizable](https://github.com/mauricius/vue-draggable-resizable)
 - [ace](https://github.com/ajaxorg/ace)
 - [adm-zip](https://github.com/cthackers/adm-zip)
-- [Ant Design Vue](https://www.antdv.com)
+- [Ant Design Vue](https://www.antdv.com)
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/02-Docker.md b/docs/02-Docker.md
@@ -162,4 +162,18 @@ docker logs elecv2p -f
 ### 一些说明
 
 - 当使用国内的一些 docker 源，因为缓存问题，更新之后可能不是最新的版本，需要手动更换一下 docker 源。（具体步骤谷歌）
-- arm32 平台如果出错，参考 [issues #78](https://github.com/elecV2/elecV2P/issues/78)
+- arm32 平台如果出错，参考 [issues #78](https://github.com/elecV2/elecV2P/issues/78)
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/03-rules.md b/docs/03-rules.md
@@ -123,4 +123,18 @@ RULES 规则列表保存于 **./script/Lists/default.list**，实际格式为严
 }
 ```
 
-*如非必要，请不要手动修改 list 源文件*
+*如非必要，请不要手动修改 list 源文件*
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/04-JS.md b/docs/04-JS.md
@@ -1070,4 +1070,18 @@ https://raw.githubusercontent.com/elecV2/elecV2P-dei/master/examples/JSTEST/fend
 
 ### BODY
 
-textarea 区域为 request body 对应值
+textarea 区域为 request body 对应值
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/05-rewrite.md b/docs/05-rewrite.md
@@ -111,4 +111,18 @@ REWRITE 规则列表保存于 **./script/Lists/rewrite.list**，实际格式为
 - *REWRITE 列表的优先级高于 RULES 规则列表。*
 - *规则订阅对其他软件的订阅格式有一定的兼容性，但并不保证完全适配。*
 - *首次命中 https 请求时，系统会自动签发一张中间证书，可能需要稍长一点时间。*
-- *推荐文章: [elecV2P 进阶使用之抓包及 COOKIE 获取](https://elecv2.github.io/#elecV2P%20%E8%BF%9B%E9%98%B6%E4%BD%BF%E7%94%A8%E4%B9%8B%E6%8A%93%E5%8C%85%E5%8F%8A%20COOKIE%20%E8%8E%B7%E5%8F%96)*
+- *推荐文章: [elecV2P 进阶使用之抓包及 COOKIE 获取](https://elecv2.github.io/#elecV2P%20%E8%BF%9B%E9%98%B6%E4%BD%BF%E7%94%A8%E4%B9%8B%E6%8A%93%E5%8C%85%E5%8F%8A%20COOKIE%20%E8%8E%B7%E5%8F%96)*
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/06-task.md b/docs/06-task.md
@@ -308,4 +308,18 @@ python3 -u https://raw.githubusercontent.com/elecV2/elecV2P/master/script/Shell/
 
 ### 其他订阅格式转换
 
-参考脚本 https://github.com/elecV2/elecV2P-dei/blob/master/examples/JSTEST/exam-tasksub.js
+参考脚本 https://github.com/elecV2/elecV2P-dei/blob/master/examples/JSTEST/exam-tasksub.js
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/07-feed&notify.md b/docs/07-feed&notify.md
@@ -180,4 +180,18 @@ $feed.bark('$enable$elecV2P 强制通知', '通过在 title 开头添加 $enable
 - 当通知主体（description）内容长度超过一定数值（默认 1200）时，会自动进行分段通知
   - 默认 feed 通知不限制字符长度，不分段
   - 单独调用（$feed.ifttt/$feed.bark/$feed.cust）时也不分段通知
-  - 只有默认通知和使用 **$feed.push**，在字符超过设定值时才会分段发送。该设定值可在 webUI->SETTING 界面修改，0 表示始终不分段
+  - 只有默认通知和使用 **$feed.push**，在字符超过设定值时才会分段发送。该设定值可在 webUI->SETTING 界面修改，0 表示始终不分段
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/08-logger&efss.md b/docs/08-logger&efss.md
@@ -306,4 +306,18 @@ v3.6.7 之后可简写为 <script favend>  -->
 - $fend key/路由 配对优化
 - runJS 直接运行 efh 文件
 - 前后台更好/优雅的传输数据($fend（done
-- 缓存清理(done) $fend.clear();
+- 缓存清理(done) $fend.clear();
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/09-webhook.md b/docs/09-webhook.md
@@ -335,4 +335,18 @@ fetch('/webhook?token=a8c259b2-67fe-D-7bfdf1f55cb3', {
 - 假如 elecV2P 可远程访问，可以使用使用其他任意程序发送网络请求进行调用
 - webhook 可配合 **telegram bot** 或 **快捷指令** 等其他工具使用，方便快速调用 elecV2P 相关功能
 - 通过 webhook 提供的 API，可以自行设计其他 UI 界面，实现与 elecV2P 交互
-- v3.5.8 在脚本中增加函数 $webhook(type, options) ，详见 https://github.com/elecV2/elecV2P-dei/blob/master/docs/04-JS.md 相关说明
+- v3.5.8 在脚本中增加函数 $webhook(type, options) ，详见 https://github.com/elecV2/elecV2P-dei/blob/master/docs/04-JS.md 相关说明
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)
diff --git a/docs/10-config.md b/docs/10-config.md
@@ -264,7 +264,7 @@ elecV2P 配置文件默认保存目录为 **./script/Lists/config.json**。
   "userid": "md5hash",         // 用户 ID。对应值为 md5(webhook token)
   "version": "3.7.3",          // 当前版本。require('./package.json').version
   "vernum": 373,               // 当前版本的数字表达。Number(version.replace(/\D/g, ''))
-  "newversion": "3.7.4",       // 检测到的新版本（如果存在的话
+  "newversion": "3.7.4"        // 检测到的新版本（如果存在的话
 }
 ```
 

diff --git a/docs/Advanced.md b/docs/Advanced.md
@@ -47,9 +47,9 @@ IP 屏蔽后，可通过在请求链接中添加 **?token=webhook token** 的参
 
 - 当设置和 webhook token 相同值时，会自动舍弃该临时 TOKEN
 - 当设置为空值时，会自动舍弃
-- 当临时 token 有相同项时，会覆盖前一项
+- 当临时 token 有相同项时，仅保留最后一项
 - 临时访问 token 同样会生成 cookie
-  - cookie 有效期同上 webhook token
+  - cookie 有效期同上面的 webhook token（7 天或 365 天）
   - cookie 可访问路径同对应 token 的可访问路径
 
 ### 安全访问检测逻辑
@@ -65,7 +65,7 @@ IP 屏蔽后，可通过在请求链接中添加 **?token=webhook token** 的参
   - 检测通过，允许请求
   - 检测失败，进入下一步
 4. token 检测
-  - 检测通过，允许请求。并将设置一个有效期为 7 或 365 天的 cookie
+  - 检测通过，允许请求。并将设置一个有效期为 7 天或 365 天的 cookie
   - 检测失败，进入下一步
 5. IP 检测
   - 检测通过，允许请求（不会设置 cookie 信息
@@ -94,7 +94,7 @@ http://127.0.0.1/webhook?token=xxxxbbff-1043-XXXX-XXXX-xxxxxxdfa05&type=devdebug
 
 - v3.4.4 之前的打开方式
 
-方法一: 在 script/Lists/config.json 中添加下面的参数，然后重启 elecV2P。
+方法一: 在配置文件中添加如下参数，然后重启 elecV2P。
 
 ``` JSON
 {
@@ -180,4 +180,18 @@ http://127.0.0.1/webhook?token=xxxxbbff-1043-XXXX-XXXX-xxxxxxdfa05&type=devdebug
 
 - 查看当前连接客户端简易信息(v3.5.0)
 
-http://127.0.0.1/webhook?token=xxxxbbff-1043-XXXX-XXXX-xxxxxxdfa05&type=devdebug&get=wsclient
+http://127.0.0.1/webhook?token=xxxxbbff-1043-XXXX-XXXX-xxxxxxdfa05&type=devdebug&get=wsclient
+
+### 说明文档列表
+
+- [overview - 简介及安装](01-overview.md)
+- [task - 定时任务](06-task.md)
+- [rewrite - 重写网络请求](05-rewrite.md)
+- [rules - 网络请求更改规则](03-rules.md)
+- [script - 脚本编写及说明](04-JS.md)
+- [Docker - Docker 运行相关](02-Docker.md)
+- [feed&notify - 通知相关](07-feed&notify.md)
+- [logger&efss - 日志和 EFSS 文件管理](08-logger&efss.md)
+- [webhook - webhook 使用简介](09-webhook.md)
+- [config - 配置文件说明](10-config.md)
+- [Advanced - 高级使用篇](Advanced.md)