Skip to content

Commit 3b5974f

Browse files
authored
更改 LOGO + 格式化 (#305)
* docs: 更改文档的 Logo,默认主机名 * docs: 格式化
1 parent b3682a9 commit 3b5974f

36 files changed

Lines changed: 1600 additions & 1586 deletions

src/.vuepress/public/favicon.ico

-54.9 KB
Binary file not shown.

src/.vuepress/public/logo.png

-92 KB
Binary file not shown.

src/.vuepress/public/logo.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/.vuepress/public/logo.webp

11.2 KB
Loading

src/.vuepress/theme.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ import navbar from "./navbar.js";
44
import sidebar from "./sidebar.js";
55

66
export default hopeTheme({
7-
hostname: "https://vuepress-theme-hope-docs-demo.netlify.app",
7+
hostname: "https://yh-api.yyyyt.top",
88

99
author: {
1010
name: "yh-third-dev",
1111
url: "https://github.com/yh-Tpdev/",
1212
},
1313

14-
logo: "https://theme-hope-assets.vuejs.press/logo.svg",
14+
logo: "/logo.webp",
1515

1616
repo: "yh-Tpdev/yhchatAPI",
1717

src/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
home: true
33
icon: house
44
title: 主页
5-
heroImage: https://theme-hope-assets.vuejs.press/logo.svg
5+
heroImage: /logo.webp
66
bgImage: /assets/Hiro.avif
77
bgImageStyle:
88
background-attachment: fixed

src/api/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ title: API
1818
- 视频路由:
1919
- `https://chat-video1.jwznb.com/`
2020

21-
云湖数据床地址需要请求头加上 `Referer: http://myapp.jwznb.com` 才可正常获取内容,否则会403.
21+
云湖数据床地址需要请求头加上 `Referer: http://myapp.jwznb.com` 才可正常获取内容,否则会403.
22+
23+
chat_type 聊天对象的类型: 1-用户, 2-群组, 3-机器人
24+
content_type 信息类型: 1-文本,2-图片,3-markdown,4-文件,5-表单,6-文章,7-表情,8-html,11-语音,13-语音通话, 14-A2UI
2225
:::
2326

2427
::: tip 如何让 LLM 写出可用性更高的代码
@@ -44,6 +47,8 @@ https://yh-api.yyyyt.top/llms-full.txt
4447
**请务必注意 protobuf 协议本身的特性.**
4548
**云湖账号的 Token 请务必小心对待不要泄露,不要将 token 硬编码到代码中.**
4649
```
47-
::::
50+
51+
:::
52+
4853

4954
<Catalog />

src/api/v1/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Proto 文件中的 Status 未特别备注均为下面内容:
1313

1414
```proto
1515
message Status {
16-
uint64 number = 1; // 不知道干啥的,可能是请求ID
17-
uint64 code = 2; // 状态码,1为正常
16+
uint64 request_id = 1; // 请求 ID
17+
uint64 code = 2; // 状态码,1 为正常
1818
string msg = 3; // 返回消息
1919
}
2020
```
@@ -23,8 +23,8 @@ message Status {
2323

2424
```JSONC
2525
{
26-
"code":1, // 返回状态码
27-
"msg":"success" //返回状态信息
26+
"code":1, // 返回状态码,1 为正常
27+
"msg":"success" //返回状态消息
2828
}
2929
```
3030

src/api/v1/beta.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ POST /v1/beta/info
1919

2020
### 响应体
2121

22-
```JSONC
22+
```JSON
2323
{
24-
"code": 1, // 请求状态码,1 为正常
24+
"code": 1,
2525
"data": {
2626
"beta": "allow", // 是否为内测用户,allow - 是,noapply - 否
2727
"info": "\n即将内测的功能:\n1、更加完整的内测功能\n2、邀请码自定义功能\n3、地区排名活动\n4、网页版云湖\n"
2828
}, // 内测信息
29-
"msg": "success" // 返回消息
29+
"msg": "success"
3030
}
3131
```

0 commit comments

Comments
 (0)