goindex-theme-r/README_zh.md

166 lines
7.9 KiB
Markdown
Raw Normal View History

2020-04-28 02:16:41 +08:00
# GoIndex-theme-acrou
2020-05-23 15:32:58 +08:00
结合 [Cloudflare Workers](https://workers.cloudflare.com/) 和 [Google Drive](https://www.google.com/drive/) 的力量你可以在Cloudflare Workers的浏览器上建立你的文件索引。
[goindex/index.js](https://github.com/Aicirou/goindex-theme-acrou/go2index) 是Workers脚本的内容。
这个主题的goindex目前是基于 [yanzai/goindex](https://github.com/yanzai/goindex/)
2020-04-28 02:16:41 +08:00
[README](README.md) | [中文文档](README_zh.md)
## 预览
Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/)
2020-05-23 15:32:58 +08:00
## 特色
2020-04-28 02:16:41 +08:00
2020-06-05 22:26:23 +08:00
- [x] 👑 页面级缓存浏览器前进后退不刷新秒加载mac用户使用触控板体验更佳
2020-05-23 15:32:58 +08:00
- [x] 🗂 多盘切换
- [x] 🔐 Http Basic Auth
- [x] 🎨 网格视图模式(文件预览)
- [x] 🎯 分页加载
- [x] 🌐 I18n多国语言
2020-07-10 18:32:38 +08:00
- [x] 🛠 Markdown/Html渲染也许它可以成为你的博客
- [x] 🖥 视频在线播放(mp4,mkv,webm,flv,m3u8,mov,m4v)
2020-06-05 22:26:23 +08:00
- [x] 🕹 支持自定义视频播放器API
2020-07-10 18:32:38 +08:00
- [x] 🎧 音频在线播放
2020-05-23 15:32:58 +08:00
- [x] 🚀 拥有更快的速度
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
## TODO
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
- [ ] 更多文件格式预览
- [ ] 让Goindex不只是一个目录索引
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
## 快速部署
2020-04-28 02:16:41 +08:00
2020-06-03 00:13:46 +08:00
1. 打开https://install.achirou.workers.dev 或者 https://goindex-quick-install.glitch.me
2020-05-23 15:32:58 +08:00
2. 授权并获取授权码
3. 将代码部署到 [Cloudflare Workers](https://www.cloudflare.com/)
2020-04-28 02:16:41 +08:00
2020-05-23 16:38:20 +08:00
## 部署
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
1. 开启[Google Drive API](https://console.developers.google.com/apis/api/drive.googleapis.com/overview)
2. 创建一个 [OAuth client ID](https://console.developers.google.com/apis/credentials/oauthclient)
3. 本地安装[rclone](https://rclone.org/downloads/)
4. 使用`rclone`获取`refresh_token`
2020-06-05 22:26:23 +08:00
5. 下载`index.js` (https://github.com/Aicirou/goindex-theme-acrou/tree/master/go2index) 然后替换`client_id`,`client_secret`,`refresh_token` 为你刚刚获取到的
2020-05-23 15:32:58 +08:00
6. 把代码部署到[Cloudflare Workers](https://www.cloudflare.com/)
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
> 如果你写了一篇不错的文章想分享给大家请提交Issues我会把链接贴在这里。
2020-04-28 02:16:41 +08:00
2020-07-10 18:32:38 +08:00
## 选项
### Video
| Option | Type | Default | Description |
| ---------- | -------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `api` | String | `''` | 外部视频播放器api。当这个值不为空时以下所有选项都不起作用。 |
| `autoplay` | Boolean | `true` | 当设置为`true`时,视频会自动播放,不过这取决于浏览器是否支持。 |
| `controls` | Array, Function or Element | `['play-large', 'restart', 'play', 'progress', 'current-time', 'duration', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'download', 'fullscreen']` | 控制栏中显示哪些按钮。详细查看[CONTROLS.md](https://github.com/sampotts/plyr/blob/master/CONTROLS.md#using-default-controls) |
| `settings` | Array | `['quality', 'speed', 'loop']` | 菜单中显示哪些设置 |
更多选项查看 plyr [options](https://github.com/sampotts/plyr#options)
### Audio
| Option | Type | Default | Description |
| ----------- | ------- | ---------- | ------------------------------------------------------------ |
| `container` | String | `.aplayer` | 不支持修改 |
| `fixed` | Boolean | `true` | 不支持修改 |
| `autoplay` | Boolean | `false` | 当设置为`true`时,音频会自动播放,不过这取决于浏览器是否支持。 |
| `loop` | String | `'all'` | 音频循环播放, 可选值: 'all', 'one', 'none' |
| `order` | String | `'list'` | 音频循环顺序, 可选值: 'list', 'random' |
| `preload` | String | `'auto'` | 预加载,可选值: 'none', 'metadata', 'auto' |
| `volume` | Number | `0.7` | 默认音量,请注意播放器会记忆用户设置,用户手动设置音量后默认音量即失效 |
| `audios` | Array | `[]` | 预设播放列表。详情查看 [FAQ](#FAQ) |
更多选项查看 APlayer [options](https://aplayer.js.org/#/home?id=options)
## 常见问题
> 怎么修改列表的排序方式?
修改第636行或者在代码中搜索`params.orderBy`
```javascript
params.orderBy = "folder,name,modifiedTime desc";
params.orderBy = "modifiedTime desc";
```
> 怎么预设音频播放列表?
音频选项中添加 `audios`
```
audio: {
audios: [
{
name: "Mojito",
artist: "周杰伦",
url: "https://xx.mp3",
lrc: "https://xx.lrc",
cover: "https://xx.jpg"
}
]
}
```
2020-05-23 16:38:20 +08:00
## 更新日志
2020-04-28 02:16:41 +08:00
2020-07-10 18:32:38 +08:00
### v2.0.8
- 修复图片文件操作列不可用问题 [#100](https://github.com/Aicirou/goindex-theme-acrou/issues/100)
- 修复错误判断图片问题 [#88](https://github.com/Aicirou/goindex-theme-acrou/issues/88)
- 修复无法设置10个以上的drive [#59](https://github.com/Aicirou/goindex-theme-acrou/issues/59) [#85](https://github.com/Aicirou/goindex-theme-acrou/issues/85)
- 添加默认视频播放器 ([plyr](https://github.com/sampotts/plyr)) [#22](https://github.com/Aicirou/goindex-theme-acrou/issues/22) [#38](https://github.com/Aicirou/goindex-theme-acrou/issues/38)
- 添加音频播放器 ([APlayer](https://github.com/MoePlayer/APlayer)) [#77](https://github.com/Aicirou/goindex-theme-acrou/issues/77)
- 视频页面添加复制按钮
- 添加 [NProgress](https://github.com/rstacruz/nprogress)
- 添加语言缓存清理
- 添加快捷方式无法下载提示 [#76](https://github.com/Aicirou/goindex-theme-acrou/issues/76)
- Markdown默认显示渲染的html
- CLI删除懒加载模块的预加载
- 删除fontawesome5
### v2.0.5
2020-06-03 00:05:04 +08:00
- 添加清理文件缓存
- 支持自定义视频播放器API
- 美化:网格模式文件无预览图时显示图标
- 美化调整HEAD.md渲染位置
- 解决搜索不能预览的文件点击无法直接下载 [#30](https://github.com/Aicirou/goindex-theme-acrou/issues/30)
- 解决文件名中有#无法打开的问题 [#20](https://github.com/Aicirou/goindex-theme-acrou/issues/20)
2020-06-03 00:13:46 +08:00
- 解决当前页面加载中切换页面会回退的问题 [#37](https://github.com/Aicirou/goindex-theme-acrou/issues/37) (感谢[@PedroZhang](https://github.com/PedroZhang)帮忙找出的问题原因)
2020-06-03 00:05:04 +08:00
2020-07-10 18:32:38 +08:00
### v2.0.0
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
- 程序改为单页应用
2020-04-28 02:16:41 +08:00
2020-06-03 00:05:04 +08:00
- 添加页面级缓存浏览器前进后退不刷新秒加载mac用户使用触控板体验更佳
2020-05-23 15:32:58 +08:00
- 添加 http basic auth每个盘符可单独配置用户名和密码可以保护该盘下所有子文件和子文件夹
- 添加网格视图模式(文件预览)
- 添加分页加载
- 添加 i18n多国语言
- 添加 html渲染
- 添加 渲染文件夹/文件的描述 (用途自行挖掘)
- 添加可选配置
- 支持快速部署(帮助小白的利器)
- 支持PDF在线预览
- 更换文本编辑器
2020-05-23 15:55:02 +08:00
- 解决url编码问题 [#20](https://github.com/Aicirou/goindex-theme-acrou/issues/20) [#23](https://github.com/Aicirou/goindex-theme-acrou/issues/23) [#25](https://github.com/Aicirou/goindex-theme-acrou/issues/25)
- 解决其他已知问题
2020-04-28 02:16:41 +08:00
2020-07-10 18:32:38 +08:00
### v1.x
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
- 支持多盘切换
- 添加版本检测
- 优化搜索结果
- 优化页面显示
2020-04-28 02:16:41 +08:00
2020-05-23 16:38:20 +08:00
## 关于
这个项目一开始仅仅是为了满足我个人观感体验开发的当这个项目收获了第一个start、第一个fork、第一个issues再到大家不断开始提建议让我有了更新下去的动力。非常感谢大家的支持得以有了现在的2.0版本。
2020-05-23 15:32:58 +08:00
## Lisense
2020-04-28 02:16:41 +08:00
2020-05-23 15:32:58 +08:00
[MIT](LICENSE)