Skip to content

Commit

Permalink
chore(docs): Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Chilfish committed Mar 1, 2024
1 parent b69465e commit 7e08203
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,28 @@

安装至油猴脚本:[weibo-archiver.user.js][releases](如果下载缓慢可用境内加速的 [镜像地址])。在用户个人主页(必须是通过点击头像来进入)刷新后将自动启动脚本,点击开始后将开始获取数据。期间请不要刷新或切换页面,否则就要重新获取。当然也可以按时间范围来选择。

有关项目的进展路线等,可见 [项目的 Todo] 部分
> [!IMPORTANT]
> 该项目还在锐意开发中,可能会有很多不稳定的 bug 等,欢迎大家提 issues 或发起讨论😇暂时只接受改 bug 的 pr <br/>
> 有关项目的进展路线等,可见 [项目的 Todo] 部分
#### 处理导出后的数据

完成后将导出包含微博数据的 `weibo-data.json` 和微博原图链接 `imgs.csv` 这两个文件。以及 `preview.zip`,解压后里面包含了用于预览的 HTML 文件和一些工具脚本。
完成后将导出包含微博数据的 `weibo-data.json` 和包含微博图片链接的 `imgs.csv`这两个文件。以及自动下载 `preview.zip`,解压后里面包含了用于预览的 HTML 文件和一些工具脚本。

1. 首先将 imgs.csv 复制到 preview 文件夹中(用于下载微博图片)

2. 接下来需要使用 `download.mjs` 来下载图片到本地(这一步也可以跳过,在预览页中启用“使用远程图片”即可,但为了永久保存图片不被突然被夹掉,还是建议下载图片)
2. 然后使用 `download.mjs` 来下载图片到本地(这一步也可以跳过,在预览页中的设置中启用“使用远程 CDN”即可,但为了永久保存图片不被突然被夹掉,还是建议下载图片)

preview 文件夹中包含了交互式一键运行的 `run.bat` 脚本(感谢 [@HayashiKaori] [#20]),按里面的提示运行即可

> 其中,运行脚本之前需要安装 Node.js,可以在 [Node.js 官网] 下载最新版本,然后找教程配置系统环境
> 其中,运行下载图片脚本之前需要安装 Node.js,可以在 [Node.js 官网] 下载最新版本,然后找教程配置系统环境
#### 查看结果

目前有两种方式预览备份后的微博

- 使用我们提供的在线预览页面:https://weibo.chilfish.top (推荐)。点击右上角的设置按钮,按提示导入刚才导出的 `weibo-data.json` 即可查看(也支持旧版导出的 data.mjs)
- 使用本地预览。暂不支持直接点击 index.html 来查看,需要启动本地的服务器。运行 `run.bat` 脚本查看
- 使用本地预览。不支持直接点击 index.html 来查看,需要启动本地的服务器。运行 `run.bat` 脚本查看

不过正在开发桌面版app,届时将不再需要这些复杂的操作,直接双击打开即可查看

Expand All @@ -61,19 +63,19 @@ preview 文件夹中包含了交互式一键运行的 `run.bat` 脚本(感谢

- **完全免费**,使用 MIT 协议开源,不会有任何收费行为。但如果要二次创作或者引用,需要注明出处和署名😇

- 若账号被封,但访问自己的主页微博,也能获取备份。也就是 **只要能能看得见,就能存档**
- 若微博账号被封,但访问自己的主页微博,也能获取备份。也就是 **只要能能看得见,就能存档**

- 关于在线预览页面,微博的数据完全保存在你的浏览器本地,你和别人都**无法通过链接来直接查看这些微博数据**。但如果你想分享给其他人查看,可以将 `weibo-data.json` 发送给他们,并按提示导入即可,同时再设置里将图片链接设为远程链接,或是填上你的图床地址
- 关于在线预览页面。上传的微博数据完全保存在你的浏览器本地,你和别人都 **无法通过链接来直接查看这些微博数据**。但如果你想分享给其他人查看,可以将 `weibo-data.json` 发送给他们,并按提示导入即可,同时再设置里将图片链接设为远程 CDN 链接,或是填上你的图床地址

- 评论区:获取时,将默认同时获取前三条热评,加上博主的评论,总数不超过 15 条。这是为了避免频繁调用接口,而可能会导致的不明问题。暂时也不支持楼中楼获取
- 评论区:获取时,将默认同时获取前 10 条热评,总数不超过 15 条。这是为了避免频繁调用接口,而可能会导致的不明问题。暂时也不支持楼中楼

- 媒体文件:只能获取图片,将以图片链接文件的形式导出,需要同时使用压缩包里的 `download.mjs` 脚本下载好之后,才能在预览页面中可见。这是为了能够离线预览,同时也是为了防止某天图片突然被夹没了😅。并且由于视频文件可能会过大、过长,将采用外链的形式来呈现。

- 可以将下载后的图片上传到你自己的图床服务器里,注意不要改变文件目录,再在预览页面的设置中填写你的图床链接即可
- 不过可以将下载后的图片上传到你自己的图床服务器里,注意不要改变文件目录,再在预览页面的设置中填写你的图床链接即可

### 对开发者

项目采用 monorepo 的结构,使用 pnpm 管理。
项目采用 monorepo 的结构,使用 pnpm 管理。Web 页面托管在 [vercel]

在 packages 目录下:

Expand All @@ -89,6 +91,8 @@ preview 文件夹中包含了交互式一键运行的 `run.bat` 脚本(感谢

只需要在根目录中 `pnpm i` 即为所有子项目安转依赖,`pnpm dev:monkey` 对应的是在 /monkey 中的 `pnpm dev`

> 注意部署构建时,需要暂时注释掉这几行代码😅)会修的 https://github.com/Chilfish/Weibo-archiver/blob/b69465e9a317710bdd9bd299a0aa105a9efec976/packages/core/src/utils/index.ts#L35-L39
目前我还在学习着 electron 开发,桌面端部分还得再等等🥺原型什么的还在设计

有关项目的进展路线等,可见 [项目的 Todo] 部分
Expand All @@ -98,11 +102,12 @@ preview 文件夹中包含了交互式一键运行的 `run.bat` 脚本(感谢
- 感谢 [speechless] 提供的基本思路
- [vite-plugin-monkey] 提供了打包成油猴脚本的工具
- [naive-ui] 提供的漂亮 UI 组件库
- [vercel] 提供的强大云平台😚
- Github Copilot 😇

### 赞助

如果你觉得这个项目对你有帮助,可以考虑赞助我一杯咖啡😇这将给我更多的动力来维护这个项目:[赞助地址]
如果你觉得这个项目对你有帮助,可以考虑赞助v我😇这将给我更多的动力来维护这个项目:[赞助地址]

[releases]: https://raw.githubusercontent.com/Chilfish/Weibo-archiver/monkey/weibo-archiver.user.js
[speechless]: https://github.com/meterscao/Speechless
Expand All @@ -116,3 +121,4 @@ preview 文件夹中包含了交互式一键运行的 `run.bat` 脚本(感谢
[镜像地址]: https://p.chilfish.top/weibo-archiver.user.js
[项目的 Todo]: https://github.com/Chilfish/Weibo-archiver/issues/7
[赞助地址]: https://chilfish.top/sponsors
[vercel]: https://vercel.com

0 comments on commit 7e08203

Please sign in to comment.