chore: 更新使用文档

dlzmoe · Aug 30, 2024 · 5d2d8b7 · 5d2d8b7
1 parent 4cfdab0
commit 5d2d8b7
Show file tree

Hide file tree

Showing 30 changed files with 87 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,2 +1,2 @@
-- 优化了 UI 的部分代码
-- 检测版本直接跳转到商店
+- 更新文档
+- 修复了部分代码
diff --git a/README.md b/README.md
@@ -13,8 +13,7 @@ linux.do 增强插件，话题列表显示创建时间，显示楼层数，新
 [Github 仓库](https://github.com/dlzmoe/linuxdo-scripts) |
 [Greasyfork 商店](https://greasyfork.org/zh-CN/scripts/501827-linuxdo-%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6) |
 [开发计划](https://github.com/users/dlzmoe/projects/2) |
-[bug 反馈](https://github.com/dlzmoe/linuxdo-scripts/issues) |
-[问题讨论区](https://github.com/dlzmoe/linuxdo-scripts/discussions)  |
+[Bug 反馈及功能请求](https://github.com/dlzmoe/linuxdo-scripts/issues/new/choose) |
 [使用和开发文档](https://linuxdo-scripts-docs.netlify.app/) 
 
 ---
@@ -67,7 +66,7 @@ node: v16.15.1
 
 功能以组件形式展开，每次新增一个功能，注册一个新的组件避免冲突。
 
-安装本仓库并下载依赖，执行运行代码
+安装本仓库并下载依赖，运行代码。
 
 ```shell
 git clone https://github.com/dlzmoe/linuxdo-scripts
@@ -78,7 +77,7 @@ yarn build # 打包构建
 
 程序会自动触发本地测试。
 
-> 关于自动构建 Release 包，需要修改 `package.json` 中的 `version` 版本号，并且在 `version-log.md` 中写入更新日志。
+> 关于自动构建 Release 包，需要修改 `package.json` 中的 `version` 版本号，并且在 `CHANGELOG.md` 中写入当前版本更新日志。
 
 
 ## 更新日志

diff --git a/dist/linuxdo-scripts.user.js b/dist/linuxdo-scripts.user.js
@@ -1,7 +1,7 @@
 // ==UserScript==
 // @name         linuxdo 增强插件
 // @namespace    https://github.com/dlzmoe/linuxdo-scripts
-// @version      0.3.4
+// @version      0.3.5
 // @author       dlzmoe
 // @description  linux.do 增强插件，功能持续更新，欢迎提出新想法！
 // @license      Apache-2.0
@@ -1015,7 +1015,7 @@
   }
   const AutoRead = /* @__PURE__ */ _export_sfc(_sfc_main$n, [["render", _sfc_render$n]]);
   const name = "linuxdo-scripts";
-  const version = "0.3.4";
+  const version = "0.3.5";
   const author = "dlzmoe";
   const description = "An enhanced script for the linux.do forum";
   const type = "module";
@@ -3532,8 +3532,9 @@ ${str}`;
   const _hoisted_16 = /* @__PURE__ */ vue.createElementVNode("a", {
     class: "btn",
     style: { "background": "#979797" },
+    target: "_blank",
     href: "https://greasyfork.org/zh-CN/scripts/501827-linuxdo-%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6"
-  }, "检测新版本", -1);
+  }, " 检测新版本 ", -1);
   const _hoisted_17 = { open: "" };
   const _hoisted_18 = /* @__PURE__ */ vue.createElementVNode("div", { class: "title" }, "楼层抽奖", -1);
   const _hoisted_19 = { class: "menu-body" };

diff --git a/docs/docs/develop/home.md b/docs/docs/develop/home.md
@@ -6,16 +6,15 @@ node: v16.15.1
 
 功能以组件形式展开，每次新增一个功能，注册一个新的组件避免冲突。
 
-1. 安装本仓库并下载依赖，执行运行代码
+安装本仓库并下载依赖，运行代码。
 
 ```shell
 git clone https://github.com/dlzmoe/linuxdo-scripts
-npm i # 安装依赖
-npm run dev # 本地运行
-npm run build # 打包构建
+yarn # 安装依赖
+yarn dev # 本地运行
+yarn build # 打包构建
 ```
 
-2. 将 `tampermonkey.js` 代码复制到油猴管理器中。
-3. 启用脚本后前往 `linux.do`，刷新页面。
+程序会自动触发本地测试。
 
-> 关于自动构建 Release 包，需要修改 `package.json` 中的 `version` 版本号，并且在 `version-log.md` 中写入更新日志。
+> 关于自动构建 Release 包，需要修改 `package.json` 中的 `version` 版本号，并且在 `CHANGELOG.md` 中写入当前版本更新日志。
diff --git a/docs/docs/guide/home.md b/docs/docs/guide/home.md
@@ -1,10 +1,8 @@
 # 首页
 
-（欢迎提交使用文档，让使用更方便。）
+[https://github.com/dlzmoe/linuxdo-scripts](https://github.com/dlzmoe/linuxdo-scripts)
 
-[https://github.com/dlzmoe/linuxdo-scripts/](https://github.com/dlzmoe/linuxdo-scripts/)
-
-> [点击安装脚本](https://raw.githubusercontent.com/dlzmoe/linuxdo-scripts/main/linuxdo-scripts.user.js)
+[https://greasyfork.org/zh-CN/scripts/501827-linuxdo 增强插件](https://greasyfork.org/zh-CN/scripts/501827-linuxdo-%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6)
 
 ---
 
@@ -14,6 +12,6 @@ linux.do 增强插件。
 
 功能持续更新，欢迎提出新想法！
 
-代码已完全开源，如果有误或其他问题，欢迎指出！
+代码已完全开源，如果有误或其他问题请指出！
 
 ![Contributor](https://contrib.rocks/image?repo=dlzmoe/linuxdo-scripts)
diff --git a/docs/docs/guide/use/MenuAutoRead.md b/docs/docs/guide/use/MenuAutoRead.md
@@ -1 +1,3 @@
 # 显示自动阅读按钮
+
+开启后可以在右下角显示自动滚动按钮，并且可以自定义调节速度，一般在 10-40 之间，不建议太大，不然网站识别不到你的阅读。
diff --git a/docs/docs/guide/use/MenuAutoexpandreply.md b/docs/docs/guide/use/MenuAutoexpandreply.md
@@ -1,3 +1,3 @@
 # 自动展开回复
 
-默认关闭，在帖子内会自动展开回复下拉。
+默认关闭，在帖子内会自动展开回复下拉。
diff --git a/docs/docs/guide/use/MenuBlockuserlist.md b/docs/docs/guide/use/MenuBlockuserlist.md
@@ -1 +1,5 @@
 # 屏蔽指定用户
+
+填入用户的账号名（唯一）而不是昵称，就屏蔽指定用户的帖子和评论。
+
+使用英文 `,` 相连。
diff --git a/docs/docs/guide/use/MenuCreatereply.md b/docs/docs/guide/use/MenuCreatereply.md
@@ -1 +1,3 @@
 # 自定义快捷回复
+
+可以自定义快捷回复在帖子右侧，点击时可以自动打开编辑框并填充文本。
diff --git a/docs/docs/guide/use/MenuEditorJa.md b/docs/docs/guide/use/MenuEditorJa.md
@@ -1 +1,3 @@
 # 编辑器切换 ja 字体
+
+一个小功能，点击后可以把编辑器中的文字以 `ja` 字体展示，喜欢这种风格的小伙伴可以开启，默认关闭。
diff --git a/docs/docs/guide/use/MenuFilterText.md b/docs/docs/guide/use/MenuFilterText.md
@@ -1 +1,3 @@
 # 是否屏蔽模糊文字
+
+帖子中经常有被设置高斯模糊的内容，开启该功能后可以自动过滤模糊，以正常文本显示。
diff --git a/docs/docs/guide/use/MenuFloorHeight.md b/docs/docs/guide/use/MenuFloorHeight.md
@@ -1 +1,3 @@
 # 智能限制楼层高度
+
+限制帖子高度，可以有效改善浏览体验。例如，某个楼层如果内容过于丰富，就需要频繁滚动，给用户带来极大的不便。为了解决这一问题，这个功能应运而生，它能够优雅地限制楼层高度，让阅读更为流畅。具体使用方法请点击打开，亲身体验这一便捷功能的独特魅力吧！
diff --git a/docs/docs/guide/use/MenuLevelSearch.md b/docs/docs/guide/use/MenuLevelSearch.md
@@ -1 +1,3 @@
 # 是否显示等级查询按钮
+
+开启后在右下角显示查看等级按钮，然后输入指定用户的用户名即可，默认填充自己的用户名。
diff --git a/docs/docs/guide/use/MenuLogoUrl.md b/docs/docs/guide/use/MenuLogoUrl.md
@@ -1 +1,3 @@
 # 自定义论坛 logo
+
+自定义论坛 logo url，可以放上自己喜欢的图片，也只有自己可以看到。
diff --git a/docs/docs/guide/use/MenuLookOP.md b/docs/docs/guide/use/MenuLookOP.md
@@ -1 +1,3 @@
 # 只看楼主按钮
+
+开启后在右下角显示按钮，可以在帖子内部，点击切换是否只看楼主。
diff --git a/docs/docs/guide/use/MenuLookmeSign.md b/docs/docs/guide/use/MenuLookmeSign.md
@@ -1 +1,3 @@
 # 只看自己签名
+
+当你既想开启自己的签名，又不想看到别人的签名时，开启这个功能。
diff --git a/docs/docs/guide/use/MenuOtherCss.md b/docs/docs/guide/use/MenuOtherCss.md
@@ -1 +1,3 @@
 # 自定义 CSS
+
+如果你懂 css 的话，可以通过 css 代码美化论坛样式！
diff --git a/docs/docs/guide/use/MenuPangu.md b/docs/docs/guide/use/MenuPangu.md
@@ -1 +1,3 @@
 # 中英文混排优化显示
+
+建议开启，使用盘古 js 美化文本显示，特别是中英文混排。
diff --git a/docs/docs/guide/use/MenuQuickAccess.md b/docs/docs/guide/use/MenuQuickAccess.md
@@ -1 +1,3 @@
 # 开启左侧快速访问
+
+开启左侧快速访问菜单，目前只有一个前往书签的路径，该功能网站本身以支持，不想删代码，就保留下来了，默认关闭。
diff --git a/docs/docs/guide/use/MenuShowAI.md b/docs/docs/guide/use/MenuShowAI.md
@@ -1 +1,5 @@
 # 显示 AI 对话网站
+
+开启后在右下角显示按钮，跳转到 shared chat，需要提前授权。
+
+https://shared.oaifree.com/dashboard
diff --git a/docs/docs/guide/use/MenuShowUnread.md b/docs/docs/guide/use/MenuShowUnread.md
@@ -1 +1,3 @@
 # 消息通知仅显示未读
+
+开启后右上角通知隐藏已读信息。
diff --git a/docs/docs/guide/use/MenuTopicpreview.md b/docs/docs/guide/use/MenuTopicpreview.md
@@ -1 +1,3 @@
 # 话题预览功能
+
+在话题列表可以预览详情，由于论坛速率限制，默认只展示前 20 楼。
diff --git a/docs/docs/guide/use/MenureplaceEmojiStyle.md b/docs/docs/guide/use/MenureplaceEmojiStyle.md
@@ -1 +1,3 @@
 # 切换论坛表情风格
+
+论坛拥有 twitter / facebook_messenger / google / google_classic / win10 多种风格的表情，可以自定义切换。
diff --git a/docs/docs/guide/use/UserTags.md b/docs/docs/guide/use/UserTags.md
@@ -1 +1,5 @@
 # 用户标签功能
+
+可以给用户打上标签，比如 `水王` 等 tag。
+
+设置中可以查看列表，修改，删除等操作。
diff --git a/docs/docs/guide/use/ai-summary.md b/docs/docs/guide/use/ai-summary.md
@@ -0,0 +1,9 @@
+# AI 总结
+
+需要在设置中预先配置好 API key 等信息，不支持 http 网址。
+
+可选择自动或者手动。
+
+如果在使用中报错，请先确认第三方 API 连通无误，并且支持你指定的模型。
+
+在以上信息无误的情况下，再提交反馈 Issues.
diff --git a/docs/docs/guide/use/default.md b/docs/docs/guide/use/default.md
@@ -1,3 +1,7 @@
 # 默认功能
 
 作为插件基础的一部分，以及在不影响整体使用的情况下，默认执行的功能。
+
+---
+
+1. 签名尾巴图裂时转文字说明
diff --git a/linuxdo-scripts.user.js b/linuxdo-scripts.user.js
@@ -1,7 +1,7 @@
 // ==UserScript==
 // @name         linuxdo 增强插件
 // @namespace    https://github.com/dlzmoe/linuxdo-scripts
-// @version      0.3.4
+// @version      0.3.5
 // @author       dlzmoe
 // @description  linux.do 增强插件，功能持续更新，欢迎提出新想法！
 // @license      Apache-2.0
@@ -1015,7 +1015,7 @@
   }
   const AutoRead = /* @__PURE__ */ _export_sfc(_sfc_main$n, [["render", _sfc_render$n]]);
   const name = "linuxdo-scripts";
-  const version = "0.3.4";
+  const version = "0.3.5";
   const author = "dlzmoe";
   const description = "An enhanced script for the linux.do forum";
   const type = "module";
@@ -3532,8 +3532,9 @@ ${str}`;
   const _hoisted_16 = /* @__PURE__ */ vue.createElementVNode("a", {
     class: "btn",
     style: { "background": "#979797" },
+    target: "_blank",
     href: "https://greasyfork.org/zh-CN/scripts/501827-linuxdo-%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6"
-  }, "检测新版本", -1);
+  }, " 检测新版本 ", -1);
   const _hoisted_17 = { open: "" };
   const _hoisted_18 = /* @__PURE__ */ vue.createElementVNode("div", { class: "title" }, "楼层抽奖", -1);
   const _hoisted_19 = { class: "menu-body" };

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "linuxdo-scripts",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "author": "dlzmoe",
   "description": "An enhanced script for the linux.do forum",
   "type": "module",

diff --git a/src/app.vue b/src/app.vue
@@ -114,9 +114,11 @@
         <a
           class="btn"
           style="background: #979797"
+          target="_blank"
           href="https://greasyfork.org/zh-CN/scripts/501827-linuxdo-%E5%A2%9E%E5%BC%BA%E6%8F%92%E4%BB%B6"
-          >检测新版本</a
         >
+          检测新版本
+        </a>
         <button class="btn import" @click="triggerFileInput">导入</button>
         <button class="btn export" @click="exportData">导出</button>
       </div>

diff --git a/version-log.md b/version-log.md
@@ -1,3 +1,8 @@
+## 0.3.5
+
+- 更新文档
+- 修复了部分代码
+
 ## 0.3.4
 
 - 优化了 UI 的部分代码