Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
D-Sketon committed Dec 28, 2024
1 parent 30d4396 commit c409d6c
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 2 deletions.
68 changes: 67 additions & 1 deletion README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,12 @@ A Hakurei Reimu style Hugo theme. Migrated from [hexo-theme-reimu](https://githu
- Mouse firework animation
- pjax
- ServiceWorker
- live2d
- live2d / live2d-widgets
- reimu Mouse Pointer
- Internal shortcode for providing internal/external/friendly link cards
- Support the bottom of the article copyright statement
- Support for configuring custom CDN sources
- Aplayer / Meting music player
- Highly customizable

## Installation
Expand Down Expand Up @@ -469,6 +470,17 @@ Disabled by default
```yaml
live2d:
enable: false
position: left # left | right
```

#### live2d-widgets

Disabled by default

```yaml
live2d_widgets:
enable: false
position: left # left | right
```

#### reimu cursor
Expand Down Expand Up @@ -567,6 +579,60 @@ sponsor: true # Whether to display the sponsorship
---
```

#### Music Player (v0.4.0+)

> Please open Pjax before using it, otherwise the player will automatically pause

Use Aplayer + Meting (optional) disabled by default

##### Aplayer

Set `player.aplayer.enable` to `true` and configure it in `player.aplayer.options` according to [Aplayer Docs](https://aplayer.js.org/#/home?id=options)

```yaml
player:
aplayer:
enable: true
options:
audio: [] # audio list
fixed:
autoplay:
loop:
order:
preload:
volume:
mutex:
listFolded:
```

##### Aplayer + Meting

Set `player.aplayer.enable` and `player.meting.enable` to `true` at the same time, and configure it in `player.meting.options` according to [Meting Docs](https://github.com/metowolf/MetingJS?tab=readme-ov-file#option), `player.aplayer.options` is the Aplayer configuration

```yaml
player:
aplayer:
enable: true
options:
audio: [] # this option will be overwritten by meting
fixed:
autoplay:
loop:
order:
preload:
volume:
mutex:
listFolded:
meting:
enable: true
meting_api: # custom api
options:
id:
server:
type:
auto:
```

</details>


Expand Down
68 changes: 67 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@ A Hakurei Reimu style Hugo theme. Migrated from [hexo-theme-reimu](https://githu
- 鼠标动画
- pjax
- ServiceWorker
- live2d
- live2d / live2d-widgets
- reimu 鼠标指针
- 内部提供内链/外链/友链卡片的短代码
- 文章底部版权声明
- 配置自定义 CDN 源
- Aplayer / Meting 音乐播放器
- 高度自定义

## 安装
Expand Down Expand Up @@ -491,6 +492,17 @@ service_worker:
```yaml
live2d:
enable: false
position: left # left | right
```

#### live2d-widgets

默认关闭

```yaml
live2d_widgets:
enable: false
position: left # left | right
```

#### reimu 鼠标指针
Expand Down Expand Up @@ -589,6 +601,60 @@ sponsor: true # 是否展示赞助二维码?
---
```

#### 音乐播放器(v0.4.0+)

> 使用前建议先打开 Pjax,否则会出现播放器自动暂停的问题

使用Aplayer + Meting(可选)默认关闭

##### 纯Aplayer

将 `player.aplayer.enable` 设置为 `true`,并在 `player.aplayer.options` 中参考 [Aplayer Docs](https://aplayer.js.org/#/home?id=options) 进行配置

```yml
player:
aplayer:
enable: true
options:
audio: [] # audio list
fixed:
autoplay:
loop:
order:
preload:
volume:
mutex:
listFolded:
```

##### Aplayer + Meting

同时将 `player.aplayer.enable` 和 `player.meting.enable` 设置为 `true`,并在 `player.meting.options` 中参考 [Meting Docs](https://github.com/metowolf/MetingJS?tab=readme-ov-file#option) 进行配置,`player.aplayer.options` 为 Aplayer 配置

```yml
player:
aplayer:
enable: true
options:
audio: [] # this option will be overwritten by meting
fixed:
autoplay:
loop:
order:
preload:
volume:
mutex:
listFolded:
meting:
enable: true
meting_api: # custom api
options:
id:
server:
type:
auto:
```

</details>

<details>
Expand Down

0 comments on commit c409d6c

Please sign in to comment.