Skip to content

Commit f24f584

Browse files
authored
测试 PR 模板 + 格式化(#307)
* docs: 格式化+更改贡献指南 * docs: 更改贡献指南
1 parent 0abcb8b commit f24f584

10 files changed

Lines changed: 47 additions & 51 deletions

File tree

src/.vuepress/config.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,5 @@ export default defineUserConfig({
1414

1515
// 和 PWA 一起启用
1616
// shouldPrefetch: false,
17-
plugins: [
18-
llmsPlugin({
19-
})
20-
]
17+
plugins: [llmsPlugin({})],
2118
});

src/.vuepress/sidebar.ts

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
import { sidebar } from "vuepress-theme-hope";
22

3-
export default sidebar(
4-
{
5-
"/api/": "structure",
6-
"/api/v1/": "structure",
7-
"/api/wss/": "structure",
8-
"/云湖API吐槽/": "structure",
9-
"/api/web/v1/": "structure",
10-
"/api/bot/": "structure",
11-
"/api/web/": "structure",
12-
"/api/bot/接入准备/": "structure"
13-
}
14-
);
3+
export default sidebar({
4+
"/api/": "structure",
5+
"/api/v1/": "structure",
6+
"/api/wss/": "structure",
7+
"/云湖API吐槽/": "structure",
8+
"/api/web/v1/": "structure",
9+
"/api/bot/": "structure",
10+
"/api/web/": "structure",
11+
"/api/bot/接入准备/": "structure",
12+
});

src/.vuepress/theme.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ export default hopeTheme({
133133
},
134134

135135
copyCode: {
136-
showInMobile: true
136+
showInMobile: true,
137137
},
138138

139139
icon: {

src/api/web/v1/bot.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ POST /v1/bot/bot-info
1111

1212
请求体:
1313

14-
```JSONC
14+
```JSON
1515
{
16-
"botId": "13972254" // 你要查询bot的ID
16+
"botId": "13972254" // 你要查询 bot 的 ID
1717
}
1818
```
1919

2020
响应体:
2121

22-
```JSONC
22+
```JSON
2323
{
2424
"code": 1,
2525
"data": {
@@ -50,7 +50,7 @@ POST /v1/bot/bot-info
5050
}
5151
}
5252
},
53-
"msg": "success" // 返回消息
53+
"msg": "success"
5454
}
5555
```
5656

@@ -66,15 +66,15 @@ POST /v1/bot/bot-link-reset
6666

6767
请求体:
6868

69-
```JSONC
69+
```JSON
7070
{
7171
"botId": "123", // 机器人ID
7272
}
7373
```
7474

7575
响应体:
7676

77-
```JSONC
77+
```JSON
7878
{
7979
"code": 1, // 请求状态码,1为正常
8080
"msg": "success" // 返回消息

src/api/web/v1/common.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ GET /v1/common/get-version
1111

1212
响应体:
1313

14-
```JSONC
14+
```JSON
1515
{
1616
"code": 1,
1717
"data": {
@@ -28,6 +28,6 @@ GET /v1/common/get-version
2828
"windowsVersion": "1.6.39", // Windows最新版本号
2929
"windowsVersionDate": "2025/11/02" // Windows最新版本更新时间
3030
},
31-
"msg": "success" // 返回消息
31+
"msg": "success"
3232
}
3333
```

src/api/web/v1/community.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ title: community
33
---
44

55
未特别说明情况下请求域名均为 `chat-web-go.jwzhd.com`
6-
没写请求/响应项目表示不需要相关参数.
6+
没写请求/响应项目表示不需要相关参数.
77

88
## 获取分区列表
99

1010
POST /v1/community/c/following-ba-list
1111

1212
请求体:
1313

14-
```JSONC
14+
```JSON
1515
{
1616
"size": 100, // 一页返回的数量
1717
"page": 1 // 页码
@@ -20,7 +20,7 @@ POST /v1/community/c/following-ba-list
2020

2121
响应体:
2222

23-
```JSONC
23+
```JSON
2424
{
2525
"code": 1, // 请求状态码,1为正常
2626
"data": {
@@ -51,7 +51,7 @@ POST /v1/community/posts/post-list
5151

5252
请求体:
5353

54-
```JSONC
54+
```JSON
5555
{
5656
"typ": 1, // 典型值
5757
"baId": 41, // 分区 id
@@ -62,7 +62,7 @@ POST /v1/community/posts/post-list
6262

6363
响应体:
6464

65-
```JSONC
65+
```JSON
6666
{
6767
"code": 1, // 请求状态码,1为正常
6868
"data": {
@@ -119,17 +119,17 @@ POST /v1/community/c/info
119119

120120
请求体:
121121

122-
```JSONC
122+
```JSON
123123
{
124124
"id": 41 // 分区 id
125125
}
126126
```
127127

128128
响应体:
129129

130-
```JSONC
130+
```JSON
131131
{
132-
"code": 1, // 请求状态码,1为正常
132+
"code": 1,
133133
"data": {
134134
"ba": {
135135
"id": 41, // 分区 id
@@ -145,6 +145,6 @@ POST /v1/community/c/info
145145
"isFollowed": "0" // 你是否关注了此分区(1为已关注,0为未关注)
146146
}
147147
},
148-
"msg": "success" // 返回消息
148+
"msg": "success"
149149
}
150150
```

src/api/web/v1/document.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ GET /v1/document/menus
1111

1212
响应体:
1313

14-
```JSONC
14+
```JSON
1515
{
16-
"code": 1, // 请求状态码,1为正常
16+
"code": 1,
1717
"data": {
1818
"menu": [
1919
{
@@ -44,7 +44,7 @@ GET /v1/document/menus
4444
// ...
4545
]
4646
},
47-
"msg": "success" // 返回消息
47+
"msg": "success"
4848
}
4949
```
5050

@@ -54,15 +54,15 @@ GET /v1/document/detail
5454

5555
请求参数:
5656

57-
| 名称 | 必须 | 备注 |
58-
| ---------- | ---- | ------------------------------ |
57+
| 名称 | 必须 | 备注 |
58+
| ---------- | ---- | ------------------------- |
5959
| documentId || 大小写敏感,类型必须是 int |
6060

6161
响应体:
6262

63-
```JSONC
63+
```JSON
6464
{
65-
"code": 1, // 请求状态码,1为正常
65+
"code": 1,
6666
"data": {
6767
"detail": {
6868
"id": 4, // 文档id
@@ -79,6 +79,6 @@ GET /v1/document/detail
7979
"remark": "11" // 不知道
8080
}
8181
},
82-
"msg": "success" // 返回消息
82+
"msg": "success"
8383
}
8484
```

src/api/web/v1/rss.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ title: rss
33
---
44

55
未特别说明情况下请求域名均为 `chat-web-go.jwzhd.com`
6-
没写请求/响应项目表示不需要相关参数.
6+
没写请求/响应项目表示不需要相关参数.
77

88
## 获取 RSS 推荐大全
99

1010
GET /v1/rss/recommend-list
1111

1212
响应体:
1313

14-
```JSONC
14+
```JSON
1515
{
16-
"code": 1, // 请求状态码,1为正常
16+
"code": 1,
1717
"data": {
1818
"list": [
1919
{
@@ -39,17 +39,17 @@ GET /v1/rss/recommend-list
3939
],
4040
"total": 28 // RSS 推荐总数
4141
},
42-
"msg": "success" // 返回消息
42+
"msg": "success"
4343
}
4444
```
4545

4646
## 提交 RSS
4747

4848
POST /v1/rss/recommend-apply
4949

50-
请求体:
50+
请求体:
5151

52-
```JSONC
52+
```JSON
5353
{
5454
"title": "轻雨Purainity的小站", // 网站标题
5555
"rssUrl": "https://jibukeshi.dpdns.org/rss.xml", // RSS 地址
@@ -60,7 +60,7 @@ POST /v1/rss/recommend-apply
6060

6161
响应体:
6262

63-
```JSONC
63+
```JSON
6464
{
6565
"code": 1, // 请求状态码,1为正常
6666
"msg": "success" // 返回消息

src/api/wss/chat-ws-go.jwzhd.com.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: chat-ws-go.jwzhd.com
33
---
44

5-
> 本文章下所有 wss 请求地址均为 `wss://chat-ws-go.jwzhd.com/ws`
5+
> 本文章下所有 wss 请求地址均为 `wss://chat-ws-go.jwzhd.com/ws`
66
77
没写 请求/响应项目 表示不需要相关参数,使用以下功能前必须先链接 wss 并 **登录云湖账号**
88

src/contribution_guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,15 @@ icon: book
3333
3. 遵循[中文排版指南](https://github.com/aaranxu/chinese-copywriting-guidelines)
3434
不要求遵循争议和推荐部分,标点符号的全角半角不强制要求遵循.
3535
4. 所写内容应能通过 VuePress 构建并且页面内容正常显示.
36+
5. commit 提交内容必须有意义.
3637

3738
## 如何贡献:
3839

3940
1. Fork [本仓库](https://github.com/yh-Tpdev/yhchatAPI)到自己账号名下.
4041
2. 通过抓包等方式获取修改依据.
4142
3. Git clone Fork 后的仓库到本地后修改并提交或者是直接在 GitHub 网页编辑器(不推荐)修改.
4243
4. 测试是否能够正常构建.
43-
5. 提交更改到远程仓库
44+
5. 提交更改到远程仓库.
4445
6. 创建一个 Pull Request 提交更改.
4546
请务必如实填写要求填写的内容,不符合要求可能会被打回.您可以到相关群聊询问审核人员请求审查和合并.
4647

0 commit comments

Comments
 (0)