Merge pull request #265 from GuoXiCheng/dev-c

update docs
GuoXiCheng · Sep 28, 2024 · 7ed5c46 · 7ed5c46
2 parents 1035d2f + 9701513
commit 7ed5c46
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 6 deletions.
diff --git a/app/src/main/java/com/android/skip/data/config/ConfigReadRepository.kt b/app/src/main/java/com/android/skip/data/config/ConfigReadRepository.kt
@@ -140,8 +140,10 @@ class ConfigReadRepository @Inject constructor(
         return Rect(left, top, right, bottom)
     }
 
+    // #region MD5
     private fun md5(input: String): String {
         val bytes = MessageDigest.getInstance("MD5").digest(input.toByteArray())
         return bytes.joinToString("") { "%02x".format(it) }
     }
+    // #endregion MD5
 }
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -73,7 +73,7 @@ export default defineConfig(
             text: "应用保活",
             items: [
               {
-                text: "功能介绍",
+                text: "应用保活功能",
                 link: "/guide/keep-alive/intro",
               },
             ],
@@ -82,7 +82,7 @@ export default defineConfig(
             text: "应用白名单",
             items: [
               {
-                text: "功能介绍",
+                text: "应用白名单功能",
                 link: "/guide/white-list/intro",
               },
             ],
@@ -100,7 +100,7 @@ export default defineConfig(
             text: "关于",
             items: [
               {
-                text: "功能介绍",
+                text: "关于功能页",
                 link: "/guide/about/intro",
               },
             ],

diff --git a/docs/guide/about/intro.md b/docs/guide/about/intro.md
@@ -1,3 +1,34 @@
 # 关于功能介绍
 
-![🚧](/images/under-construction.png)
+## 源代码
+
+点击「源代码」功能按钮时，会跳转到 GitHub 仓库页面，方便查看源代码。
+
+但某些情况下，如果网络缓慢，可能会出现无法访问的情况。
+
+## 文档
+
+点击「文档」功能按钮时，会跳转到「SKIP」文档页面，可以查看完整文档。
+
+## 应用版本号
+
+点击「应用版本号」功能按钮时，会主动检查应用的版本号：
+
+- 如果有新版本，会提示更新
+- 如果没有新版本，会显示当前版本号
+
+## 配置版本号
+
+点击「配置版本号」功能按钮时，会主动检查配置的版本号。
+
+如果在自定义配置输入框中填写了：
+
+- 有效的 URL 地址，会从该地址获取配置文件，并显示版本号。如果反复点击配置版本号，会重新获取配置文件并显示最新的版本号
+- 有效的纯文本的配置内容，会显示对应的版本号，并且即使反复点击配置版本号也不会变化
+- 无效的配置内容，会显示「未检测到有效的配置」
+
+### 配置版本号的算法
+
+配置版本号的算法是通过计算 JSON 字符串格式配置文件的 MD5 值来实现的，因此，只要配置内容不变，配置版本号就不会变化。
+
+<<< @/../app/src/main/java/com/android/skip/data/config/ConfigReadRepository.kt#MD5
diff --git a/docs/guide/keep-alive/intro.md b/docs/guide/keep-alive/intro.md
@@ -1,3 +1,13 @@
 # 应用保活功能介绍
 
-![🚧](/images/under-construction.png)
+## 为什么要应用保活
+
+在移动端，应用保活是指应用在后台运行时，保持应用的一些功能或服务持续运行，以提升用户体验。例如，音乐播放器在后台播放音乐。
+
+为了保证无障碍服务的正常运行，需要保证应用在后台运行时，服务不会被系统回收。因此，需要使用应用保活功能。
+
+## 应用保活的方式
+
+- 允许应用自启动
+- 锁定应用
+- 使用前台服务常驻通知栏
diff --git a/docs/guide/white-list/intro.md b/docs/guide/white-list/intro.md
@@ -1,3 +1,5 @@
 # 应用白名单功能介绍
 
-![🚧](/images/under-construction.png)
+应用白名单功能会列出所有已经安装的应用，可以在右上角的菜单中选择是否「列出系统应用」。因为系统应用较多，所以默认是不列出的。
+
+当把一个应用加入白名单时（开关打开状态），「SKIP」就不会对这个应用执行任何「点击」的动作（无论是否在配置中定义），因此，该功能可以用来防止「SKIP」对某些应用的干扰。