Skip to content

Commit

Permalink
docs: cleanup 2 (#46)
Browse files Browse the repository at this point in the history
* docs: cleanup 2

* Apply suggestions from lyswhut

* Apply suggestions from lyswhut
  • Loading branch information
3gf8jv4dv authored Jan 20, 2025
1 parent bf2c2b2 commit 3de83ed
Show file tree
Hide file tree
Showing 16 changed files with 57 additions and 36 deletions.
8 changes: 4 additions & 4 deletions docs/desktop/custom-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,11 @@ send(EVENT_NAMES.inited, {

```

- `@name `:源的名字,建议不要过长,24 个字符以内。
- `@description `:源的描述,建议不要过长,36 个字符以内,可不填,不填时可以删除它。
- `@name`:源的名字,建议不要过长,24 个字符以内。
- `@description`:源的描述,建议不要过长,36 个字符以内,可不填,不填时可以删除它。
- `@version`:源的版本号,可不填,不填时可以删除它。
- `@author `:源的作者名字,可不填,不填时可以删除它。
- `@homepage `:源的主页,可不填,不填时可以删除它。
- `@author`:源的作者名字,可不填,不填时可以删除它。
- `@homepage`:源的主页,可不填,不填时可以删除它。

## `globalThis.lx`

Expand Down
2 changes: 1 addition & 1 deletion docs/desktop/faq/change-music-position.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ title: 批量调整「我的列表」中歌曲的顺序

批量调整顺序可以按你**所选中歌曲时**的顺序去调整顺序。

例如若想要快速**翻转**列表内的歌曲顺序,可以先去到列表底部,按 <kbd>Shift</kbd> 或 <kbd>Ctrl</kbd> 选中最后一首歌,然后去到列表顶部,按 <kbd>Shift</kbd> 选中第一首歌,这时会完成**整个列表的倒序选中**然后右击任意一首歌打开菜单选择调整顺序,输入 `1` 回车即可完成列表内歌曲的翻转。
例如若想要快速**翻转**列表内的歌曲顺序,可以先去到列表底部,按 <kbd>Shift</kbd> 或 <kbd>Ctrl</kbd> 选中最后一首歌,然后去到列表顶部,按 <kbd>Shift</kbd> 选中第一首歌,这时会完成**整个列表的倒序选中**然后右击任意一首歌打开菜单,选择「调整位置」,输入 `1` 回车即可完成列表内歌曲的翻转。

另外你还可以使用 <kbd>Ctrl</kbd> 键选择多个歌曲后调整顺序,这将按照你选中时的顺序去调整歌曲的位置。
2 changes: 1 addition & 1 deletion docs/desktop/faq/headphones-turn-off-unexpectedly.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ title: 使用软件时导致耳机意外关机

详情看:[https://github.com/lyswhut/lx-music-desktop/issues/457](https://github.com/lyswhut/lx-music-desktop/issues/457)

若出现该问题可尝试添加 `-dhmkh` 启动参数解决,启动参数添加方法请自行百度「windows给快捷方式添加启动参数」
若出现该问题可尝试添加 `-dhmkh` 启动参数解决,启动参数添加方法请自行百度 `给快捷方式添加参数`

6 changes: 3 additions & 3 deletions docs/desktop/faq/install-failed.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ title: 安装失败

对于部分电脑出现安装失败的问题,可以做出以下尝试:

- 若你之前可以安装成功,但现在安装失败,可以去「**控制面板 → 程序和功能**」或用第三方卸载工具看下有没有之前的版本残留,若同时在不同路径下安装了多个版本就可能会出现该问题,这种情况卸载掉所有版本重新安装即可。
- 若你之前可以安装成功,但现在安装失败,可以去「**控制面板 → 程序和功能/卸载程序**」或用第三方卸载工具看下有没有之前的版本残留,若同时在不同路径下安装了多个版本就可能会出现该问题,这种情况卸载掉所有版本重新安装即可。
- 清理安装路径下的残留文件。
- 清理注册表(建议用清理工具清理)。

#### 安装结束后,无法启动软件

安装结束后,安装目录只有卸载程序没有其他内容
安装结束后,安装目录只有卸载程序,而没有其他内容

- 可能是你使用错了安装包。*例如使用 Windows Arm64 版安装包在 x64 系统安装就会出现这个问题。*
- 覆盖安装时更改了安装目录。*覆盖安装时不能更改安装目录,若想更改目录需将软件卸载再安装。*

解决方式:使用**控制面板 → 卸载程序**功能卸载应用,然后选择对应安装包安装,一般即可解决。
解决方式:**控制面板 → 程序和功能/卸载程序**中卸载软件,然后选择对应安装包安装,一般即可解决。

#### 提示缺少 `xxx.dll`

Expand Down
10 changes: 5 additions & 5 deletions docs/desktop/faq/interface-abnormal.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: 界面异常(界面显示不完整、界面无法显示)

> 最近发现是electron的通病,可以尝试在Nvidia控制面板中关闭「平滑处理-FXAA」
若以上方式无法解决你的问题,可以尝试添加运行参数 `--no-sandbox` 启动,例如:`.\lx-music-desktop.exe --no-sandbox`,添加方法可自行百度 `给快捷方式加参数`
若以上方式无法解决你的问题,可以尝试添加运行参数 `--no-sandbox` 启动,例如:`.\lx-music-desktop.exe --no-sandbox`,添加方法可自行百度 `给快捷方式添加参数`

尝试将 `--no-sandbox` 逐个换成以下参数启动,直到恢复正常为止:

Expand All @@ -32,9 +32,9 @@ title: 界面异常(界面显示不完整、界面无法显示)
> Transparent windows will not work when DWM is disabled.
> *禁用 DWM 时,透明窗口将不起作用。*
因此,当 Windows 7 没有使用 **Aero 主题**时,界面将会显示异常,开启 Aero 的方法请自行百度`win7开启Aero效果`(开启后可看到任务栏有透明效果)。
因此,当 Windows 7 没有使用 **Aero 主题**时,界面将会显示异常,开启 Aero 的方法请自行百度 `Win7 开启 Aero 效果`(开启后可看到任务栏有透明效果)。

`0.14.0` 版本起不再强制要求开启透明效果,若你实在不想开启(若非电脑配置太低,墙裂建议开启!),可通过添加运行参数 `-dt` 运行程序即可,例如:`.\lx-music-desktop.exe -dt`,添加方法可自行百度 `给快捷方式加参数`,该参数的作用是用来控制程序是否使用非透明窗口运行。
`0.14.0` 版本起不再强制要求开启透明效果,若你实在不想开启(若非电脑配置太低,墙裂建议开启!),可通过添加运行参数 `-dt` 运行程序即可,例如:`.\lx-music-desktop.exe -dt`,添加方法可自行百度 `给快捷方式添加参数`,该参数的作用是用来控制程序是否使用非透明窗口运行。

:::tip
启用 **Aero 主题**后,若软件出现黑边框,则重启软件即可恢复正常。
Expand All @@ -48,11 +48,11 @@ title: 界面异常(界面显示不完整、界面无法显示)

原始 Issue 看:[https://github.com/electron/electron/issues/19569#issuecomment-522231083](https://github.com/electron/electron/issues/19569#issuecomment-522231083)

解决办法:下载 `.NET Framework 4.7.1` **或更高版本**安装即可(建议安装最新版,若安装过程中遇到问题可尝试自行百度解决)。
解决办法:下载 **.NET Framework 4.7.1 或更高版本**安装即可(建议安装最新版,若安装过程中遇到问题可尝试自行百度解决)。

Microsoft 官方下载地址:[https://dotnet.microsoft.com/download/dotnet-framework](https://dotnet.microsoft.com/download/dotnet-framework)

下载 `Runtime(运行时)` 版即可,安装完成后可能需要重启才生效。**若出现闪烁的情况**,可阅读下面的「**Windows 7 整个界面闪烁**」解决。
下载**Runtime (运行时)**版即可,安装完成后可能需要重启才生效。**若出现闪烁的情况**,可阅读下面的「**Windows 7 整个界面闪烁**」解决。

### Windows 7 整个界面闪烁(消失又出现)

Expand Down
4 changes: 2 additions & 2 deletions docs/desktop/faq/list-play-all.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ title: 播放整个歌单或排行榜

- 在「设置 → 列表设置」开启「双击列表里的歌曲时自动切换到当前列表播放」功能,此功能仅对「歌单」和「排行榜」有效,默认关闭。
- 使用列表的「播放」和「收藏」功能,这两个功能可以在歌单详情页上方以及右击排行榜名字的菜单中使用,其中「收藏」功能是把当前歌曲列表添加到「我的列表」中,可以在「我的列表」找到该列表播放,而且后续还可以使用列表右键菜单的「更新」功能更新此列表。
- 使用 [多选功能](./list-multiple-selection) 全选列表内歌曲后将歌曲添加到「稍后播放」或「我的列表」播放。
- 使用[多选功能](./list-multiple-selection)全选列表内歌曲后,将歌曲添加到「稍后播放」或「我的列表」播放。

### 播放搜索列表内的歌曲

由于搜索列表内的歌曲可能有很多页内容,所以未添加类似歌单、排行榜的「一键播放」功能,播放该列表需要使用 [多选功能](./list-multiple-selection) 将歌曲添加到「我的列表」或「稍后播放」队列中播放。
由于搜索列表内的歌曲可能有很多页内容,所以未添加类似歌单、排行榜的「一键播放」功能,播放该列表需要使用[多选功能](./list-multiple-selection)将歌曲添加到「我的列表」或「稍后播放」队列中播放。
2 changes: 1 addition & 1 deletion docs/desktop/faq/playlist.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: 音乐播放列表机制
8. 在切歌时若不是通过「上一曲」「下一曲」功能切歌(例如直接点击「排行榜」「我的列表」中的歌曲切歌),「稍后播放」队列将会被清空,若处于随机模式下,则「已播放的歌曲」队列也会被清空。*v2.3.0 起默认不再清空「已播放歌曲」队列,可以在「设置 → 播放设置」中开启*

:::tip
相关内容
**相关内容**

- [列表多选](./list-multiple-selection)
- [可用的鼠标、键盘快捷操作](./hotkey)
Expand Down
8 changes: 4 additions & 4 deletions docs/desktop/faq/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ title: 同步功能的使用
:::

:::tip
目前桌面版最新版已可以与移动版最新版进行同步。如果你之前升级过 v2.0.0 版本,后来降级到 v1.x.x 版本,你可以删除 [数据目录](../datapath) 中的 `LxDatas` 目录,再次升级到最新版本即可。
目前桌面版最新版已可以与移动版最新版进行同步。如果你之前升级过 v2.0.0 版本,后来降级到 v1.x.x 版本,你可以删除[数据目录](../datapath)中的 `LxDatas` 目录,再次升级到最新版本即可。
:::

从 v2.2.0 起,桌面版的同步功能有两种工作模式:

- 服务端模式,用于在同一局域网下,为其他设备提供同步服务。
- 客户端模式,与移动版一样,可用于连接另一个处于「服务端模式」的桌面版或独立版数据同步服务。

如果你有服务器,可以考虑部署我们开发的 [独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme) 到你的服务器上,作为私人多端同步服务使用。
如果你有服务器,可以考虑部署我们开发的[独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme)到你的服务器上,作为私人多端同步服务使用。

## 服务端模式

Expand Down Expand Up @@ -60,13 +60,13 @@ title: 同步功能的使用

## 客户端模式

该功能用于连接 [独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme) 或同一局域网下另一个启用了「服务端模式」的桌面版。
该功能用于连接[独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme) 或同一局域网下另一个启用了「服务端模式」的桌面版。

1. 在桌面版的「设置 → 数据同步」选择「客户端模式」;
2. 输入同步服务地址,使用方法与移动版一致,详情看「服务端模式」使用方法的第 2、3 点。

:::tip
若你使用的是 [独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme),则注意以下几点:
若你使用的是[独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme),则注意以下几点:

- 若你配置了 SSL 证书,则需要将上面第 3 步 `http://x.x.x.x:23332` 中的 `http:` 改为 `https:`
- 若你使用了域名,则将 `x.x.x.x` 换成你的域名。
Expand Down
4 changes: 2 additions & 2 deletions docs/desktop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

软件变化请查看[更新日志](https://github.com/lyswhut/lx-music-desktop/blob/master/CHANGELOG.md)

软件下载请查看 [GitHub Releases](https://github.com/lyswhut/lx-music-desktop/releases)
软件下载请查看[软件下载](/download)

目前本项目的原始发布地址只有 [**GitHub Releases**](https://github.com/lyswhut/lx-music-desktop/releases),其他渠道均为第三方转载发布,与本项目无关!
目前本项目的原始发布地址只有 [**GitHub**](https://github.com/lyswhut/lx-music-desktop/releases),其他渠道均为第三方转载发布,与本项目无关!

为了提高使用门槛,本软件内的默认设置、UI 操作不以新手友好为目标,所以使用前建议先根据你的喜好浏览调整一遍软件设置,阅读一遍[音乐播放列表机制](/desktop/faq/playlist)[可用的鼠标、键盘快捷操作](/desktop/faq/hotkey)

Expand Down
8 changes: 4 additions & 4 deletions docs/mobile/custom-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,11 @@ send(EVENT_NAMES.inited, {
*/
```

- `@name `:源的名字,建议不要过长,24 个字符以内。
- `@description `:源的描述,建议不要过长,36 个字符以内,可不填,不填时可以删除它。
- `@name`:源的名字,建议不要过长,24 个字符以内。
- `@description`:源的描述,建议不要过长,36 个字符以内,可不填,不填时可以删除它。
- `@version`:源的版本号,可不填,不填时可以删除它。
- `@author `:源的作者名字,可不填,不填时可以删除它。
- `@homepage `:源的主页,可不填,不填时可以删除它。
- `@author`:源的作者名字,可不填,不填时可以删除它。
- `@homepage`:源的主页,可不填,不填时可以删除它。

## `globalThis.lx`

Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/faq/change-music-position.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ title: 批量调整「我的列表」中歌曲的顺序

批量调整顺序可以按你**所选中歌曲时**的顺序去调整顺序。

例如若想要快速**翻转**列表内的歌曲顺序,可以先去到列表底部,长按最后一首歌将其选中,然后在顶部的选择模式中选择「**区间**」,去到列表顶部,点击第一首歌将其选中,这时会完成**整个列表的倒序选中**,然后点击任意一首歌右侧的 `` 打开菜单选择调整顺序,输入 `1` 回车即可完成列表内歌曲的翻转
例如若想要快速**翻转**列表内的歌曲顺序,可以先去到列表底部,长按最后一首歌将其选中,然后在顶部的选择模式中选择「**区间**」,去到列表顶部,点击第一首歌将其选中,这时会完成**整个列表的倒序选中**,然后点击任意一首歌右侧的 `` 打开菜单,选择「调整位置」,输入 `1` 并点击「确认」即可完成列表内歌曲的翻转

另外你还可以使用「单选」模式选择多个歌曲后调整顺序,这将按照你选中时的顺序去调整歌曲的位置。
2 changes: 1 addition & 1 deletion docs/mobile/faq/desktop-lyric.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: 桌面歌词启用后不显示
---


Android 6 及更高的版本需要给予 LX Music 显示悬浮窗的权限才能使用桌面歌词功能,请确认是否授予此权限(不懂怎么授予的话请自行百度开启悬浮窗权限)。
Android 6 及更高的系统版本需要给予 LX Music 显示悬浮窗的权限才能使用桌面歌词功能,请确认是否授予此权限(不懂怎么授予的话请自行百度 `Android 开启悬浮窗权限`)。

### 授予了悬浮窗权限,在软件内可以显示桌面歌词,软件切后台后歌词消失

Expand Down
4 changes: 2 additions & 2 deletions docs/mobile/faq/list-play-all.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ title: 播放整个歌单或排行榜

- 在「设置 → 列表设置」开启「点击列表里的歌曲时自动切换到当前列表播放」功能,此功能仅对「歌单」和「排行榜」有效,默认关闭。
- 使用列表的「播放」和「收藏」功能,这两个功能可以在歌单详情页上方以及长按排行榜名字的菜单中使用,其中「收藏」功能是把当前歌曲列表添加到「我的列表」中,可以在「我的列表」找到该列表播放,而且后续还可以使用列表菜单按钮中的「更新」功能更新此列表。
- 使用 [多选功能](./list-multiple-selection) 全选列表内歌曲后将歌曲添加到「稍后播放」或「我的列表」播放。
- 使用[多选功能](./list-multiple-selection)全选列表内歌曲后,将歌曲添加到「稍后播放」或「我的列表」播放。

### 播放搜索列表内的歌曲

由于搜索列表内的歌曲可能有很多页内容,所以未添加类似歌单、排行榜的「一键播放」功能,播放该列表需要使用 [多选功能](./list-multiple-selection) 将歌曲添加到「我的列表」或「稍后播放」队列中播放。
由于搜索列表内的歌曲可能有很多页内容,所以未添加类似歌单、排行榜的「一键播放」功能,播放该列表需要使用[多选功能](./list-multiple-selection)将歌曲添加到「我的列表」或「稍后播放」队列中播放。

4 changes: 2 additions & 2 deletions docs/mobile/faq/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: 同步功能的使用
由于同步传输时的数据是明文传输,请在受信任的网络下使用此功能!
:::

需要配合处于「服务端模式」的桌面版使用,如果你有公网服务器,也可以考虑部署我们开发的 [独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme) 到你的服务器上,作为私人多端同步服务使用。
需要配合处于「服务端模式」的桌面版使用,如果你有公网服务器,也可以考虑部署我们开发的[独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme)到你的服务器上,作为私人多端同步服务使用。

桌面版与移动版处在同一个局域网(路由器的网络)下或在公网部署了独立版数据同步服务时,可以多端实时同步歌曲列表。

Expand All @@ -29,7 +29,7 @@ title: 同步功能的使用
5. 若连接成功,对于首次同步时,若两边的设备的列表不为空,则桌面版会弹出选择列表同步方式的弹窗,同步方式的说明弹窗下方有介绍。

:::tip
若你使用的是 [独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme),则注意以下几点:
若你使用的是[独立版数据同步服务](https://github.com/lyswhut/lx-music-sync-server#readme),则注意以下几点:

- 若你配置了 SSL 证书,则需要将上面第 3 步 `http://x.x.x.x:23332` 中的 `http:` 改为 `https:`
- 若你使用了域名,则将 `x.x.x.x` 换成你的域名。
Expand Down
6 changes: 3 additions & 3 deletions docs/mobile/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@

已支持的平台:

- Android
- Android 5 及以上

***注:目前没有计划支持 iOS 和 HarmonyOS NEXT。***

软件变化请查看[更新日志](https://github.com/lyswhut/lx-music-mobile/blob/master/CHANGELOG.md)

软件下载请查看 [GitHub Releases](https://github.com/lyswhut/lx-music-mobile/releases)
软件下载请查看[软件下载](/download)

目前本项目的原始发布地址只有 [**GitHub Releases**](https://github.com/lyswhut/lx-music-mobile/releases),其他渠道均为第三方转载发布,与本项目无关!
目前本项目的原始发布地址只有 [**GitHub**](https://github.com/lyswhut/lx-music-mobile/releases),其他渠道均为第三方转载发布,与本项目无关!

为了提高使用门槛,本软件内的默认设置、UI 操作不以新手友好为目标,所以使用前建议先根据你的喜好浏览调整一遍软件设置,阅读一遍[音乐播放列表机制](/mobile/faq/playlist)

Expand Down
Loading

0 comments on commit 3de83ed

Please sign in to comment.