From 98d31c1ca06b743f08b1d25b2e37789bd86b915c Mon Sep 17 00:00:00 2001
From: PJ568 <PJ568@PJ568.eu.org>
Date: Mon, 16 Dec 2024 11:19:54 +0800
Subject: [PATCH] =?UTF-8?q?=E3=80=90=E6=96=87=E6=A1=A3=E3=80=91=E6=96=B0?=
 =?UTF-8?q?=E5=A2=9E=E7=A8=8B=E5=BA=8F=E9=80=BB=E8=BE=91=E5=9B=BE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md    |  1 +
 README_EN.md |  1 +
 doc/logic.md | 40 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 42 insertions(+)
 create mode 100644 doc/logic.md

diff --git a/README.md b/README.md
index aa230a3..249146c 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@
 ## 代码或内容贡献
 
 欢迎每一位对本项目感兴趣的朋友贡献代码和内容。
+请参阅[程序逻辑](doc/logic.md)。
 
 较为简单的提交贡献方法可查阅[贡献文档](CONTRIBUTING.md)以了解相关信息。
 
diff --git a/README_EN.md b/README_EN.md
index dbe9981..e76d201 100644
--- a/README_EN.md
+++ b/README_EN.md
@@ -23,6 +23,7 @@ This project aims to provide a low-dependency, simple deployment solution for re
 ## Code or Content Contributions
 
 We welcome contributions of code and content from anyone interested in this project.
+Please checkout [程序逻辑](doc/logic.md).
 
 For a simpler way to contribute, please refer to the [Contribution Guide](CONTRIBUTING.md) for relevant information.
 
diff --git a/doc/logic.md b/doc/logic.md
new file mode 100644
index 0000000..6ec5192
--- /dev/null
+++ b/doc/logic.md
@@ -0,0 +1,40 @@
+# 程序逻辑
+
+- 初始化
+  - 初始化深色模式 (`initDarkmode`)
+  - 初始化返回首页按钮 (`initHomeBtn`)
+  - 初始化内容 (`initContent`)
+    - 显示 Markdown (`showMarkdown`)
+      - 获取 Markdown 路径 (`getPValue`)
+      - 解码 Markdown 路径 (`decodeMDPath`)
+      - 格式化路径 (`formatMDPath`)
+      - 获取 Markdown 内容 (`getMarkdown`)
+        - 解析 Markdown (`marked.parse`)
+        - 处理内部链接
+      - 更新页面内容
+      - 自定义推送状态 (`customPushState`)
+  - 初始化页面翻译 (`initTranslate`)
+  - 初始化 PJAX (`initPJAX`)
+  - 初始化自定义 PJAX (`initCustomPJAX`)
+    - 覆写 PJAX 处理响应的函数
+    - 监听自定义链接的点击事件
+- 事件监听
+  - 网页加载完毕 (`DOMContentLoaded`)
+  - PJAX 开始 (`pjax:send`)
+    - 开始加载动画 (`startLoad`)
+  - PJAX 完成 (`pjax:complete`)
+    - 初始化自定义 PJAX (`initCustomPJAX`)
+  - 点击事件委托
+    - 返回上一页 (`#back-btn`)
+    - 刷新页面 (`#refresh-btn`)
+    - 切换深色模式 (`#dark_b`)
+    - 切换语言 (`#translate-switch`)
+- 文档内容加载完毕 (`showMarkdownEnded`)
+  - 刷新翻译 (`refreshTranslate`)
+  - 检查并提示翻译 (`infoTranslate`)
+  - 执行翻译 (`translate.execute`)
+  - 结束加载动画 (`endLoad`)
+  - 添加 `loaded` 类
+  - 平滑滚动到顶部
+- 浏览器返回 (`onpopstate`)
+  - 更新层级 (`level`)