From 146f5bf925319112e492ee07b0ab3975fdedb60d Mon Sep 17 00:00:00 2001 From: Aicirou <2643053021@qq.com> Date: Fri, 10 Jul 2020 18:32:38 +0800 Subject: [PATCH] :pencil:Update README --- README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++---- README_zh.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 160 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e586cf9..38ac9b3 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,10 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) - [x] 🎨 Grid view mode(File Preview) - [x] 🎯 Paging load - [x] 🌐 I18n(multi-language) -- [x] 🛠 Html render -- [x] 🖥 Video Online(mp4,mkv,webm,flv,m3u8) +- [x] 🛠 Markdown/Html render (Maybe it can be your blog) +- [x] 🖥 Video Online(mp4,mkv,webm,flv,m3u8,mov,m4v) - [x] 🕹 Support for custom video player (API) +- [x] 🎧 Audio Online - [x] 🚀 Faster speed ## TODO @@ -48,9 +49,84 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) > If you write a good article and want to share it with others, please submit Issues and I will post the link here. -## Logs +## Options -### 2020-06-02 +### Video + +| Option | Type | Default | Description | +| ------------ | -------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `api` | String | `''` | External video player api. When this value is not null, all of the following options do not work | +| `autoplay` | Boolean | `true` | When set to true, the video plays automatically, depending on whether the browser supports the | +| `invertTime` | Boolean | `false` | Display the current time as a countdown rather than an incremental counter. | +| `controls` | Array, Function or Element | `['play-large', 'restart', 'play', 'progress', 'current-time', 'duration', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'download', 'fullscreen']` | Which buttons are displayed in the control bar. See more [CONTROLS.md](https://github.com/sampotts/plyr/blob/master/CONTROLS.md#using-default-controls) | +| `settings` | Array | `['quality', 'speed', 'loop']` | You can specify which settings to show in the menu | + +For more option, see plyr [options](https://github.com/sampotts/plyr#options) + +### Audio + +| Option | Type | Default | Description | +| ----------- | ------- | ---------- | ------------------------------------------------------------ | +| `container` | String | `.aplayer` | No support for changes | +| `fixed` | Boolean | `true` | No support for changes | +| `autoplay` | Boolean | `false` | audio autoplay | +| `loop` | String | `'all'` | player loop play, values: 'all', 'one', 'none' | +| `order` | String | `'list'` | player play order, values: 'list', 'random' | +| `preload` | String | `'auto'` | values: 'none', 'metadata', 'auto' | +| `volume` | Number | `0.7` | default volume, notice that player will remember user setting, default volume will not work after user set volume themselves | +| `audios` | Array | `[]` | Playlists can be preset. [FAQ](#FAQ) | + +For more option, see APlayer [options](https://aplayer.js.org/#/home?id=options) + +## FAQ + +> How do I change the way the list is sorted? + +Modify line 636 of the code or search for `params.orderBy` + +```javascript +－ params.orderBy = "folder,name,modifiedTime desc"; +＋ params.orderBy = "modifiedTime desc"; +``` + +> How to preset an audio playlist? + +Audio option add `audios` + +``` +audio: { + audios: [ + { + name: "Mojito", + artist: "周杰伦", + url: "https://xx.mp3", + lrc: "https://xx.lrc", + cover: "https://xx.jpg" + } + ] +} +``` + + + +## Change log + +### v2.0.8 + +- Fix image file actions does not work [#100](https://github.com/Aicirou/goindex-theme-acrou/issues/100) +- Fix misjudged file to image format [#88](https://github.com/Aicirou/goindex-theme-acrou/issues/88) +- Fix more than 10 drive not working [#59](https://github.com/Aicirou/goindex-theme-acrou/issues/59) [#85](https://github.com/Aicirou/goindex-theme-acrou/issues/85) +- Add video default player([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) +- Add audio player ([APlayer](https://github.com/MoePlayer/APlayer)) [#77](https://github.com/Aicirou/goindex-theme-acrou/issues/77) +- Add copy button to video page +- Add [NProgress](https://github.com/rstacruz/nprogress) +- Add language cache cleanup +- Add shortcut can't download tip [#76](https://github.com/Aicirou/goindex-theme-acrou/issues/76) +- Markdown displays rendered html by default +- CLI Delete prefetch preload of lazy load module +- Delete fontawesome5 + +### v2.0.5 - Add clean file cache - Support for custom video player (API) @@ -60,7 +136,7 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) - Solve the problem that the file name cannot be opened [#20](https://github.com/Aicirou/goindex-theme-acrou/issues/20) - Solve the problem that switching pages will fall back in the current page loading [#37](https://github.com/Aicirou/goindex-theme-acrou/issues/37) (Thanks [@PedroZhang](https://github.com/PedroZhang) Help to find out the cause of the problem) -### 2020-5-20 +### v2.0.0 - Program changed to SPA(single page application) - Add page level cache(Browser forward and backward do not refresh seconds to load, and Mac users have a better experience of using touch pad) @@ -77,7 +153,7 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) - Solve the problem of URL encoding [#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) - Solve other known problems -### 2020-4-29 +### v1.x - Support multi disk switching - Add version detection diff --git a/README_zh.md b/README_zh.md index bf71cc2..0c8ec11 100644 --- a/README_zh.md +++ b/README_zh.md @@ -20,9 +20,10 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) - [x] 🎨 网格视图模式（文件预览） - [x] 🎯 分页加载 - [x] 🌐 I18n（多国语言） -- [x] 🛠 html渲染 -- [x] 🖥 视频在线播放(mp4,mkv,webm,flv,m3u8) +- [x] 🛠 Markdown/Html渲染（也许它可以成为你的博客） +- [x] 🖥 视频在线播放(mp4,mkv,webm,flv,m3u8,mov,m4v) - [x] 🕹 支持自定义视频播放器（API） +- [x] 🎧 音频在线播放 - [x] 🚀 拥有更快的速度 ## TODO @@ -47,9 +48,81 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) > 如果你写了一篇不错的文章，想分享给大家，请提交Issues，我会把链接贴在这里。 +## 选项 + +### 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-06-02 +### 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 - 添加清理文件缓存 - 支持自定义视频播放器（API） @@ -59,7 +132,7 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) - 解决文件名中有#无法打开的问题 [#20](https://github.com/Aicirou/goindex-theme-acrou/issues/20) - 解决当前页面加载中切换页面会回退的问题 [#37](https://github.com/Aicirou/goindex-theme-acrou/issues/37) (感谢[@PedroZhang](https://github.com/PedroZhang)帮忙找出的问题原因) -### 2020-5-20 +### v2.0.0 - 程序改为单页应用 @@ -77,7 +150,7 @@ Acrou: [https://oss.achirou.workers.dev/](https://oss.achirou.workers.dev/) - 解决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-4-29 +### v1.x - 支持多盘切换 - 添加版本检测