小修小改 (#297)

* docs: 修改首页背景和主题色

* docs: 小修小改

Author: yyyytawa

src/.vuepress/public/assets/Hiro.avif

@@ -1,2 +1,2 @@
 // you can change config here
-$theme-color: #096dd9;
+$theme-color: #d00611;

src/.vuepress/styles/config.scss

@@ -3,11 +3,10 @@ home: true
 icon: house
 title: 主页
 heroImage: https://theme-hope-assets.vuejs.press/logo.svg
-bgImage: https://theme-hope-assets.vuejs.press/bg/6-light.svg
-bgImageDark: https://theme-hope-assets.vuejs.press/bg/6-dark.svg
+bgImage: /assets/Hiro.avif
 bgImageStyle:
   background-attachment: fixed
-heroText: 云湖API
+heroText: ""
 tagline: 云湖API文档
 actions:
   - text: API文档
@@ -21,9 +20,61 @@ actions:
 copyright: false
 footer: 使用 <a href="https://theme-hope.vuejs.press/zh/" target="_blank">VuePress Theme Hope</a> 主题 | CC-BY-SA 4.0
 ---
+<style>
+/* 1. 针对背景图容器，创建一个全覆盖的深色遮罩层 */
+.vp-hero-mask::after {
+  content: "";
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  /* 这里的 rgba(0, 0, 0, 0.6) 表示 60% 透明度的黑色 */
+  /* 你可以根据需要调整这个数值，数值越大越暗 */
+  background-color: rgba(0, 0, 0, 0.6) !important;
+  z-index: 1; /* 确保遮罩在图片之上 */
+}
 
-云湖已发现API及调用的非官方参考文档.目的是方便开发者进行二次开发使用.  
+/* 2. (可选) 稍微降低图片自身的对比度，也有助于凸显文字 */
+.vp-hero-mask {
+  filter: contrast(0.9) !important;
+}
+
+/* 3. 重要！必须确保文字和按钮内容在遮罩层之上 */
+.vp-hero-info {
+  position: relative;
+  z-index: 2; /* 确保它在 z-index 1 的遮罩层上面 */
+}
+
+/* 4. 优化文字和按钮颜色，使用高对比度的白色 */
+.vp-hero-title {
+  color: #ffffff !important;
+  /* 增加轻微的文字阴影，进一步辅助识别 */
+  text-shadow: 0 2px 4px rgba(0, 0, 0, 0.8) !important;
+}
+
+#main-description {
+  color: #eeeeee !important; /* 描述文字稍微调灰一点点，增加层次感 */
+  text-shadow: 0 1px 3px rgba(0, 0, 0, 0.8) !important;
+}
+
+/* 5. 针对你图片中看不清的 "Github仓库" 按钮进行修复 */
+.vp-hero-action.default {
+  /* 强制设置一个带透明度的灰色背景，防止背景图干扰 */
+  background-color: rgba(255, 255, 255, 0.15) !important;
+  color: #ffffff !important;
+  border: 1px solid rgba(255, 255, 255, 0.3) !important;
+  backdrop-filter: blur(4px); /* 按钮局部加一点模糊，非常实用 */
+}
+
+/* 针对主要按钮（API文档），确保它足够醒目 */
+.vp-hero-action.primary {
+  box-shadow: 0 2px 6px rgba(0, 0, 0, 0.3) !important;
+}
+</style>
+
+云湖已发现API及调用的非官方参考文档.方便开发者进行二次开发使用.  
 **本文档默认你拥有相关编程基础,不解决过于小白的问题.**  
-**所有API信息只做为公开参考**  
+**所有API信息仅限参考**  
 **所有API调用请遵循相关法律法规以及云湖的用户协议,本项目仅用于学习研究用途.**  
 **由于文档的特殊性,可能会因为某些原因随时停止服务.**

src/README.md

@@ -6,7 +6,7 @@ timeline: false
 article: false
 ---
 
-这里存放的是 `v1` API 的文档.  
+这里存放的是 `v1` 路由下的 API 的文档.  
 无特别说明,请求域名均为 `https://chat-go.jwzhd.com/`  
 一般为 JSON 或者是 ProtoBuf 格式.  
 Proto 文件中的 Status 未特别备注均为下面内容:

src/api/v1/README.md

@@ -2,7 +2,7 @@
 title: check
 ---
 
-> 未特别说明情况下请求域名均为 `https://chat-go.jwzhd.com` .
+未特别说明情况下请求域名均为 `https://chat-go.jwzhd.com` .
 
 没写请求/响应项目表示不需要相关参数.
 
@@ -63,7 +63,7 @@ POST /v1/check/get-latest-version
 ## 获取云湖新版本（Windows 版本）
 
 ```http request
-POST https://chat-go.jwzhd.com/v1/check/check-version
+POST /v1/check/check-version
 ```
 
 ### 请求体

src/api/v1/check.md

@@ -1120,3 +1120,47 @@ message dismiss_group {
 ```
 
 :::
+
+## 获取语音房间列表
+
+POST /v1/group/live-room
+
+请求头:
+
+| 名称  | 必须 | 备注 |
+| ----- | ---- | ---- |
+| token | 是   | 无   |
+
+请求体：
+
+```JSONC
+{
+  "groupId": "big" // 群聊id
+}
+```
+
+响应体：
+
+```JSONC
+{
+  "code": 1, // 请求状态码，1为正常
+  "data": {
+    "rooms": [
+      {
+        "userId": "1234567", // 用户id
+        "roomId": "c7552ca7c79546dd93baca4e4adxxxxx", // 房间id
+        "chatId": "123456789", // 房间所发起的会话id
+        "title": "", // 房间标题
+        "chatType": 2, // 房间所发起的会话类型
+        "status": 0, // 房间状态
+        "createBy": "1234567", // 发起房间的用户id
+        "createTime": 1775881889, // 房间创建时间戳
+        "nickname": "111", // 房间创建者名称
+        "count": 1, // 房间人数
+        "avatarUrl": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png" // 房间创建者头像Url
+      }
+    ]
+  },
+  "msg": "success" // 返回消息
+}
+```

src/api/v1/group.md

@@ -30,7 +30,7 @@ POST /v1/live/add
 {
   "code": 1, // 请求状态码，1为正常
   "data": {
-    "joinToken: ": "123123123123123123", // 语音频道进入token
+    "joinToken": "123123123123123123", // 语音频道进入token,是 livekit 的 access_token
   },
   "msg": "success" // 返回消息
 }
@@ -205,47 +205,3 @@ POST /v1/live/get-calling
 ```
 
 :::
-
-## 获取语音房间列表
-
-POST /v1/group/live-room
-
-请求头:
-
-| 名称  | 必须 | 备注 |
-| ----- | ---- | ---- |
-| token | 是   | 无   |
-
-请求体：
-
-```JSONC
-{
-  "groupId": "big" // 群聊id
-}
-```
-
-响应体：
-
-```JSONC
-{
-  "code": 1, // 请求状态码，1为正常
-  "data": {
-    "rooms": [
-      {
-        "userId": "1234567", // 用户id
-        "roomId": "c7552ca7c79546dd93baca4e4adxxxxx", // 房间id
-        "chatId": "123456789", // 房间所发起的会话id
-        "title": "", // 房间标题
-        "chatType": 2, // 房间所发起的会话类型
-        "status": 0, // 房间状态
-        "createBy": "1234567", // 发起房间的用户id
-        "createTime": 1775881889, // 房间创建时间戳
-        "nickname": "111", // 房间创建者名称
-        "count": 1, // 房间人数
-        "avatarUrl": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png" // 房间创建者头像Url
-      }
-    ]
-  },
-  "msg": "success" // 返回消息
-}
-```

src/api/v1/live.md

@@ -13,7 +13,7 @@ POST /v1/mount-setting/create
 
 | 名称  | 必须 | 备注              |
 | ----- | ---- | ----------------- |
-| token | 是   | 目标群管理员token |
+| token | 是   | 普通用户的 token 也可(若后续改了欢迎 PR) |
 
 请求体:
 
@@ -45,7 +45,7 @@ POST /v1/mount-setting/delete
 
 | 名称  | 必须 | 备注              |
 | ----- | ---- | ----------------- |
-| token | 是   | 目标群管理员token |
+| token | 是   | 普通用户的 token 也可(若后续改了欢迎 PR) |
 
 请求体:
 

src/api/v1/mount-setting.md

@@ -598,7 +598,7 @@ POST /v1/user/module-ignore
 
 ```JSONC
 {
- "deviceId": "1234"
+ "deviceId": "1234",
  "ignore": ",30,20,10" // 模块id，10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面
 }
 ```

src/api/v1/user.md

@@ -9,6 +9,4 @@ timeline: false
 
 Web 端 API 文档
 
-> [v1](./v1/)
-
 <Catalog />