Skip to content

Commit

Permalink
docs: 文档更新
Browse files Browse the repository at this point in the history
  • Loading branch information
ikun0014 committed Apr 11, 2024
1 parent bd10b7e commit 1338e61
Show file tree
Hide file tree
Showing 14 changed files with 56 additions and 22 deletions.
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,8 @@
"vue": "^3.4.21",
"vuepress": "2.0.0-rc.9",
"vuepress-theme-hope": "2.0.0-rc.34"
},
"dependencies": {
"lxgw-wenkai-webfont": "^1.7.0"
}
}
9 changes: 9 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified src/.vuepress/public/favicon.ico
Binary file not shown.
Binary file removed src/.vuepress/public/logo.png
Binary file not shown.
1 change: 0 additions & 1 deletion src/.vuepress/public/logo.svg

This file was deleted.

7 changes: 6 additions & 1 deletion src/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ export default sidebar({
text: "部署",
icon: "book",
prefix: "deploy/",
children: "structure",
collapsible: true,
link: "deploy/readme.md",
children: [
"deploy-windows.md",
"deploy-linuxordarwin.md",
],
},
{
text: "API调用方法",
Expand Down
1 change: 1 addition & 0 deletions src/.vuepress/styles/config.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// you can change config here
$colors: #c0392b, #d35400, #f39c12, #27ae60, #16a085, #2980b9, #8e44ad, #2c3e50,
#7f8c8d !default;
$font-family: '"LXGW WenKai", sans-serif';
12 changes: 7 additions & 5 deletions src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@ import { hopeTheme } from "vuepress-theme-hope";
import sidebar from "./sidebar.js";

export default hopeTheme({
hostname: "https://vuepress-theme-hope-docs-demo.netlify.app",
hostname: "https://helloplhm-qwq.github.io/lx-music-api-server",

iconAssets: "fontawesome-with-brands",

logo: "https://img2.imgtp.com/2024/04/08/AaDnm8dY.png",

repo: "vuepress-theme-hope/vuepress-theme-hope",
repo: "helloplhm-qwq/lx-music-api-server",

docsDir: "src",

docsBranch: "docs",

// 导航栏
// navbar,

// 侧边栏
sidebar,

// 页脚
footer: "Copyright © 2024 All Devloper",
displayFooter: true,

// 加密配置
Expand All @@ -45,8 +46,8 @@ export default hopeTheme({
provider: "Giscus",
repo: "helloplhm-qwq/lx-music-api-server",
repoId: "R_kgDOKr11fg",
category: "Announcements",
categoryId: "DIC_kwDOG_Pt2M4COD69",
category: "General",
categoryId: "DIC_kwDOKr11fs4CemjW",
},

components: {
Expand All @@ -65,6 +66,7 @@ export default hopeTheme({
imgSize: true,
include: true,
mark: true,
alert: true,
stylize: [
{
matcher: "Recommended",
Expand Down
1 change: 0 additions & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,5 @@ features:
- title: 快速响应
details: 采用aiohttp进行异步请求,毫秒级响应
icon: magic
footer: 'Copyright © 2024 All Devloper'
footerHtml: true
---
16 changes: 16 additions & 0 deletions src/deploy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
head:
- - meta
- name: keywords
content: 即刻开始
title: 部署
icon: docs
author: ikun0014
date: 2024-04-11
index: true
---

## 部署方法

Windows请看:[Win](./deploy-windows.md)
Linux/MacOS请看:[Linux or Mac](deploy-linuxordarwin.md)
File renamed without changes.
3 changes: 2 additions & 1 deletion src/guide/deploy-windows.md → src/deploy/deploy-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ index: false

## 部署教程

1.下载Python3.10-3.11
1.下载Python3.10-3.11
前往[Python官网](https://www.python.org/downloads/release/python-3119)下拉即可找到Python3.11.9的下载链接
如图![图1](https://img2.imgtp.com/2024/04/11/q3NfsbUp.png)
18 changes: 8 additions & 10 deletions src/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,21 @@
head:
- - meta
- name: keywords
content: 即刻开始
content: 项目介绍
title: 介绍
icon: docs
author: ikun0014
date: 2024-04-10
index: true
---

## 部署方法

### Windows

- [点我前往](./deploy-windows.md)

### Linux/Mac OS

- [点我前往](./deploy-linuxordarwin.md)
## 简述
这是一个基于Python的LX Music后端实现,与LX Music相关的只有请求格式,其余全部重写
项目基于 MIT 开源许可证开源于[Github](https://github.com/helloplhm-qwq/lx-music-api-server)
所调用API接口为网络上查找
音乐平台不易,请尊重版权,支持正版。
本项目仅用于对技术可行性的探索及研究,不接受任何商业(包括但不限于广告等)合作及捐赠。
若对此有疑问请 mail to:helloplhm-qwq@outlook.com

## 项目官方交流群

Expand Down
7 changes: 4 additions & 3 deletions src/guide/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
head:
- - meta
- name: keywords
content: API调用方法
title: API调用方法
content: API接口
title: API接口
icon: docs
author: ikun0014
date: 2024-04-10
index: false
---

# Test
# 接口列表

0 comments on commit 1338e61

Please sign in to comment.