From d9f301911ce7cf2fb8efb3d3a632e5c63ad0e363 Mon Sep 17 00:00:00 2001 From: lqzh <9134671+lqzhgood@users.noreply.github.com> Date: Sat, 18 Nov 2023 20:00:39 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs(=E6=96=87=E6=A1=A3):=20?= =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E6=B5=81=E7=A8=8B=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.ts | 27 ++++++++++--------- docs/guide/use/begin.md | 55 +++++++++++++++++++++++++++++++++++++++ docs/guide/use/get.md | 43 +++++------------------------- docs/guide/use/merger.md | 6 ++++- 4 files changed, 80 insertions(+), 51 deletions(-) create mode 100644 docs/guide/use/begin.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 5629e0f3..9a501465 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -51,13 +51,26 @@ export default defineConfig({ { text: '使用说明', items: [ + { text: '开始吧', link: '/guide/use/begin' }, { text: 'Get', link: '/guide/use/get' }, { text: 'Merger', link: '/guide/use/merger' }, { text: 'Show', link: '/guide/use/show' }, ], }, { - text: '数据格式', + text: '安装运行时环境', + collapsed: true, + items: [ + { text: 'nodejs', link: '/guide/setup-runtime/nodejs' }, + { text: 'python', link: '/guide/setup-runtime/python' }, + { text: 'java', link: '/guide/setup-runtime/java' }, + { text: 'php', link: '/guide/setup-runtime/php' }, + { text: 'docker', link: '/guide/setup-runtime/docker' }, + { text: '常见问题', link: '/guide/setup-runtime/Q&A' }, + ], + }, + { + text: '开发-数据格式', items: [ { text: 'Shmily-Msg', @@ -90,18 +103,6 @@ export default defineConfig({ { text: 'Shmily-Data', link: '/guide/use/data' }, ], }, - { - text: '安装运行时环境', - collapsed: true, - items: [ - { text: 'nodejs', link: '/guide/setup-runtime/nodejs' }, - { text: 'python', link: '/guide/setup-runtime/python' }, - { text: 'java', link: '/guide/setup-runtime/java' }, - { text: 'php', link: '/guide/setup-runtime/php' }, - { text: 'docker', link: '/guide/setup-runtime/docker' }, - { text: '常见问题', link: '/guide/setup-runtime/Q&A' }, - ], - }, { text: '其他', items: [ diff --git a/docs/guide/use/begin.md b/docs/guide/use/begin.md new file mode 100644 index 00000000..e374c547 --- /dev/null +++ b/docs/guide/use/begin.md @@ -0,0 +1,55 @@ +# 开始吧 + +## 概述 + +对于用户来说, 希望一个软件足够简单,打开一个窗口,点击一个按钮, 就可以得到最终的 `结果` . 这称为黑盒, 所有的事情都被这个按钮挡住的了,不利于 debug 与 程序的解耦. + +若有些人只希望导出 MobileQQ 的数据做一个自己的 Ai 机器人 ,并不需要`Show(展示数据)`. 如果按照以上的设计,他还需要从上述按钮获取的展示 `结果` 逆向为数据. + +所以 Shmily 的使用是在 `程序解耦` 与 `使用便利` 之间取舍. 我希望 Shmily 对于不懂编程的人能简单使用, 同时也能足够解耦拆分足够细, 不让开发者 [重造轮子](https://baike.baidu.com/item/%E9%87%8D%E9%80%A0%E8%BD%AE%E5%AD%90/16837040), 中间的纽带就是文档了. + +因为我自身是 Shimly 的开发者,很容易一叶障目, 所以我也很希望你们从各种角度对文档提出各方面的问题来完善文档. 欢迎 [提出建议](https://github.com/lqzhgood/Shmily/issues/new) + +基于以上 Shmily 的使用会被拆分为很多个步骤, 而且没有 GUI 界面, 这会让人看起来感觉很复杂, 但我保证, 每个步骤基本都是拷贝文件, 执行一行命令 完了~ 别担心~ + +## 大致步骤 + +`Get(获取数据)` ---> `Merger(合并数据)` ---> `Show(展示数据)` + +::: tip +大多数情况下 `Merger(合并数据)` 可以跳过 +::: + +## 开始项目 + +大部分项目并不会打包为开箱即用的 `"exe"`, 如果您非程序员, 请按以下步骤操作 + +### 1. 下载项目 + +Github 为例, 点击下图中 `Download ZIP` 即可下载当前项目源码 +![down repo](./assets/down_repo.png) + +### 2. 安装项目运行时环境 + +根据不同的项目语言安装不同的运行时环境, `Github` 会自动标注主要语言 +![what-languages](./assets/what-languages.png) + +也可以按照下面列出的特性, 安装对应语言的运行时 + +- [nodejs](../setup-runtime/nodejs) (项目中有 `package.json` 文件) + +- [python](../setup-runtime/python) (大量 `.py` 后缀文件) + +- [java](../setup-runtime/java) (大量 `.java` 后缀文件) + +### 3. Get-获取数据 + +[参考 Get 文档](./get.md) + +### 4. Merger-合并数据 (可选) + +[参考 Merger 文档](./merger.md) + +### 5. Show-展示数据 + +[参考 Show 文档](./show.md) diff --git a/docs/guide/use/get.md b/docs/guide/use/get.md index 916520ef..4c0c79a9 100644 --- a/docs/guide/use/get.md +++ b/docs/guide/use/get.md @@ -1,5 +1,7 @@ # Get +从 [支持列表](./get.md#支持列表) 中选择所需项目, 按照相应的文档操作 + ## 支持列表 下面列出现有已知的 Get 项目, 更多项目可在 `Github` 搜索 [`Shmily-Get-`](https://github.com/search?q=Shmily-Get-&type=repositories) @@ -29,41 +31,12 @@ - `EMAIL` 电子邮件 - [电子邮件](https://github.com/lqzhgood/Shmily-Get-Email) -## 开始项目 - -大部分项目并不会打包为开箱即用的 `"exe"` - -如果您非程序员, 下面将简单讲解 **通用** 的步骤 - -### 1. 下载项目 - -Github 为例, 点击下图中 `Download ZIP` 即可下载当前项目源码 -![down repo](./assets/down_repo.png) - -### 2. 安装项目运行时环境 - -根据不同的项目语言安装不同的运行时环境, `Github` 会自动标注主要语言 -![what-languages](./assets/what-languages.png) - -也可以按照下面列出的特性, 安装对应语言的运行时 +## 产物结构 -- [nodejs](../setup-runtime/nodejs) (项目中有 `package.json` 文件) - -- [python](../setup-runtime/python) (大量 `.py` 后缀文件) - -- [java](../setup-runtime/java) (大量 `.java` 后缀文件) - -### 3. 获取数据 - -从 [支持列表](./get.md#支持列表) 中点击所需项目, 按照相应的文档操作 - -### 4. 得到数据 - -可以在输出目录（一般是 `dist`）获得 +最终可以在输出目录（一般是 `dist`）获得 `数据文件` 和 `资源文件` ``` -// 结构示例 -// 由于历史原因，可能有部分 Get 输出并未遵循此规则，慢慢重构吧 +// 示例 - dist - MobileQQ-lqzh-20230101.json <--- 数据文件 @@ -74,7 +47,7 @@ Github 为例, 点击下图中 `Download ZIP` 即可下载当前项目源码 - videos ... - - _temp <--- 输出过程中的一些信息，如下载错误的文件等 + - _temp <--- 输出过程中的一些信息，如下载错误的列表等 - DOWN_ERROR.json - XXXX.json ``` @@ -101,7 +74,3 @@ Github 为例, 点击下图中 `Download ZIP` 即可下载当前项目源码 - 对于外链的资源，建议能爬下来的资源(如图片)都本地化, 过个几年这些 URL 都打不开了 - -### 5. 展示 - -[参考 Show 文档](./show.md) diff --git a/docs/guide/use/merger.md b/docs/guide/use/merger.md index f88477e5..ad60401f 100644 --- a/docs/guide/use/merger.md +++ b/docs/guide/use/merger.md @@ -1,6 +1,10 @@ # Merger -用来合并去重 **不同来源含相同内容** `${msg}.json` 的项目 +用来对 **不同来源(Get), 相同内容** 的 `数据文件` 合并去重 + +如通过 `Android 短信` 导出了 2010-2015 的短信, `QQ 同步助手` 导出了 2013-2018 的短信 + +可以通过此工具去重 2013-2015 年的部分. ::: danger !!! 如可以接受重复内容, 或多个 `数据文件` 不含重复内容, 不需要运行此项目 !!!