Skip to content

Commit 12e65b5

Browse files
authored
Merge pull request #693 from RainyGrass/docs/docs-update
docs: 文档更新
2 parents 8a50b15 + acbd65e commit 12e65b5

1 file changed

Lines changed: 76 additions & 23 deletions

File tree

README.md

Lines changed: 76 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<img alt="logo" height="100" width="100" src="public/icons/favicon.png" />
3-
<h2>SPlayer</h2>
4-
<p>一个简约的音乐播放器</p>
3+
<h2> SPlayer </h2>
4+
<p> 一个简约的音乐播放器 </p>
55

66
[API Docs](https://splayer.imsyy.top/api.html) | [交流群](https://qm.qq.com/cgi-bin/qm/qr?k=2-cVSf1bE0AvAehCib00qFEFdUvPaJ_k&jump_from=webapi&authKey=1NEhib9+GsmsXVo2rCc0IbRaVHeeRXJJ0gbsyKDcIwDdAzYySOubkFCvkV32+7Cw) | [开发版](https://github.com/imsyy/SPlayer/actions) | [发行版](https://splayer.imsyy.top/download.html)
77

@@ -17,6 +17,38 @@
1717

1818
![main](/screenshots/SPlayer.jpg)
1919

20+
# 目录
21+
22+
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
23+
24+
<!-- code_chunk_output -->
25+
26+
- [目录](#目录)
27+
- [说明](#说明)
28+
- [严肃警告](#严肃警告)
29+
- [💬 交流群](#-交流群)
30+
- [👀 Demo](#-demo)
31+
- [🎉 功能](#-功能)
32+
- [🖼️ 界面展示](#️-界面展示)
33+
- [📦️ 获取](#️-获取)
34+
- [二进制安装方案](#二进制安装方案)
35+
- [稳定版](#稳定版)
36+
- [开发版](#开发版)
37+
- [自行部署方案](#自行部署方案)
38+
- [⚙️ Docker 部署](#️-docker-部署)
39+
- [本地构建](#本地构建)
40+
- [在线部署](#在线部署)
41+
- [⚙️ Vercel 部署](#️-vercel-部署)
42+
- [⚙️ 服务器部署](#️-服务器部署)
43+
- [⚙️ 本地部署](#️-本地部署)
44+
- [😘 鸣谢](#-鸣谢)
45+
- [🗺️ 贡献者联盟](#️-贡献者联盟)
46+
- [📢 免责声明](#-免责声明)
47+
- [📜 开源许可](#-开源许可)
48+
- [⭐ Star History](#-star-history)
49+
50+
<!-- /code_chunk_output -->
51+
2052
## 说明
2153

2254
![提示](/screenshots/gitcodes.png)
@@ -47,7 +79,9 @@
4779

4880
## 👀 Demo
4981

50-
- [SPlayer](https://music.imsyy.top/)
82+
- 在线演示:[SPlayer](https://music.imsyy.top/)
83+
84+
> 如打不开,说明已经失效请自行前往 [获取](#️-获取)
5185
5286
## 🎉 功能
5387

@@ -80,77 +114,77 @@
80114
- 🎵 支持 Last.fm Scrobble(播放记录上报)
81115
- ~~📱 移动端基础适配~~
82116

83-
## 🖼️ screenshots
117+
## 🖼️ 界面展示
84118

85119
> 开发中,仅供参考
86120
87121
<details>
88-
<summary>主页面</summary>
122+
<summary> 主页面 </summary>
89123

90124
![主页面](/screenshots/SPlayer%20-%20主页面.jpg)
91125

92126
</details>
93127

94128
<details>
95-
<summary>播放页面</summary>
129+
<summary> 播放页面 </summary>
96130

97131
![播放页面](/screenshots/SPlayer%20-%20播放页面.jpg)
98132

99133
</details>
100134

101135
<details>
102-
<summary>发现页面</summary>
136+
<summary> 发现页面 </summary>
103137

104138
![发现页面](/screenshots/SPlayer%20-%20发现页面.jpg)
105139

106140
</details>
107141

108142
<details>
109-
<summary>歌单页面</summary>
143+
<summary> 歌单页面 </summary>
110144

111145
![发现页面](/screenshots/SPlayer%20-%20歌单页面.jpg)
112146

113147
</details>
114148

115149
<details>
116-
<summary>评论页面</summary>
150+
<summary> 评论页面 </summary>
117151

118152
![发现页面](/screenshots/SPlayer%20-%20评论页面.jpg)
119153

120154
</details>
121155

122156
<details>
123-
<summary>本地音乐</summary>
157+
<summary> 本地音乐 </summary>
124158

125159
![发现页面](/screenshots/SPlayer%20-%20本地音乐.jpg)
126160

127161
</details>
128162

129163
## 📦️ 获取
130164

131-
### 稳定版
165+
### 二进制安装方案
166+
167+
#### 稳定版
132168

133169
通常情况下,可以在 [Releases](https://github.com/imsyy/SPlayer/releases) 中获取稳定版
134170

135171
也可前往 [SPlayer 官网](https://splayer.imsyy.top/) 获取稳定版
136172

137-
### 开发版
173+
#### 开发版
138174

139175
可以通过 `GitHub Actions` 工作流获取最新的开发版,目前开发版仅提供 `Win` 版本
140176

141177
> 如需其他平台的开发版构建,请自行 Fork 本项目并参考 `.github/workflows/release.yml` 创建相应的工作流
142178
143179
[Dev Workflow](https://github.com/imsyy/SPlayer/actions/workflows/dev.yml)
144180

145-
## Snap Store
146-
147-
[![Get it from the Snap Store](https://snapcraft.io/en/dark/install.svg)](https://snapcraft.io/splayer)
181+
### 自行部署方案
148182

149-
## ⚙️ Docker 部署
183+
#### ⚙️ Docker 部署
150184

151185
> 安装及配置 `Docker` 将不在此处说明,请自行解决
152186
153-
### 本地构建
187+
##### 本地构建
154188

155189
> 请尽量拉取最新分支后使用本地构建方式,在线部署的仓库可能更新不及时
156190
@@ -164,7 +198,7 @@ docker run -d --name SPlayer -p 25884:25884 splayer
164198
docker-compose up -d
165199
```
166200

167-
### 在线部署
201+
##### 在线部署
168202

169203
```bash
170204
# 从 Docker Hub 拉取
@@ -176,9 +210,9 @@ docker pull ghcr.io/imsyy/splayer:latest
176210
docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
177211
```
178212

179-
以上步骤成功后,将会在本地 [localhost:25884](http://localhost:25884/) 启动,如需更换端口,请自行修改命令行中的端口号
213+
以上步骤成功后,将会在本地 [localhost: 25884](http://localhost:25884/) 启动,如需更换端口,请自行修改命令行中的端口号
180214

181-
## ⚙️ Vercel 部署
215+
#### ⚙️ Vercel 部署
182216

183217
> 其他部署平台大致相同,在此不做说明
184218
@@ -197,7 +231,7 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
197231

198232
6. 点击 `Deploy`,即可成功部署
199233

200-
## ⚙️ 服务器部署
234+
#### ⚙️ 服务器部署
201235

202236
1. 重复 `⚙️ Vercel 部署` 中的 1 - 4 步骤
203237
2. 克隆仓库
@@ -228,7 +262,7 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
228262

229263
5. 将站点运行目录设置为 `out/renderer` 目录
230264

231-
## ⚙️ 本地部署
265+
#### ⚙️ 本地部署
232266

233267
1. 本地部署需要用到 `Node.js`。可前往 [Node.js 官网](https://nodejs.org/zh-cn/) 下载安装包,请下载最新稳定版
234268
2. 安装 pnpm
@@ -252,7 +286,7 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
252286

253287
## 😘 鸣谢
254288

255-
特此感谢为本项目提供支持与灵感的项目
289+
特此感谢为本项目提供支持与灵感的项目
256290

257291
- [NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi)
258292
- [YesPlayMusic](https://github.com/qier222/YesPlayMusic)
@@ -262,6 +296,23 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
262296
- [refined-now-playing-netease](https://github.com/solstice23/refined-now-playing-netease)
263297
- [material-color-utilities](https://github.com/material-foundation/material-color-utilities)
264298

299+
## 🗺️ 贡献者联盟
300+
301+
欢迎加入我们 🥰! 一起为 SPlayer 贡献一份力量。
302+
感谢以下所有贡献者 💖
303+
304+
<a href="https://github.com/imsyy/SPlayer/graphs/contributors" target="_blank" rel="noopener">
305+
<picture>
306+
<source media="(prefers-color-scheme: dark)"
307+
srcset="https://contrib.rocks/image?repo=imsyy/SPlayer&max=30&anon=1&theme=dark&v=1">
308+
<img src="https://contrib.rocks/image?repo=imsyy/SPlayer&max=30&anon=1&v=1"
309+
alt="SPlayer 项目贡献者"
310+
width="650"
311+
loading="lazy"
312+
style="border-radius: 10px; transition: transform 0.2s ease;">
313+
</picture>
314+
</a>
315+
265316
## 📢 免责声明
266317

267318
本项目部分功能使用了网易云音乐的第三方 API 服务,**仅供个人学习研究使用,禁止用于商业及非法用途**
@@ -283,6 +334,8 @@ docker run -d --name SPlayer -p 25884:25884 imsyy/splayer:latest
283334
5. **社区参与:** 欢迎社区的参与和贡献,我们鼓励开发者一同改进和维护本项目
284335
6. **许可证链接:** 请阅读 [GNU Affero General Public License (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.html) 了解更多详情
285336

337+
338+
286339
## ⭐ Star History
287340

288341
[![Star History Chart](https://api.star-history.com/svg?repos=imsyy/SPlayer&type=Date)](https://star-history.com/#imsyy/SPlayer&Date)

0 commit comments

Comments
 (0)