Skip to content

Commit 1884579

Browse files
1ctrl-cvQianLin-Jiaxi
authored andcommitted
docs: 格式化更多的文档
1 parent 99e0ab8 commit 1884579

5 files changed

Lines changed: 17 additions & 11 deletions

File tree

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
node_modules/
32
src/.vuepress/.cache/
43
src/.vuepress/.temp/

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
## 云湖目前已发现并记录的所有可用API及其调用文档
2-
此文档库为云湖社交目前已发现并被记录的所有可用API及其对应的调用文档,目的便于开发者进行相关二次开发
3-
所有路由需要在最前补全https://chat-go.jwzhd.com 域名后再请求
4-
5-
**所有API信息只做为公开参考**
1+
# 云湖目前已发现并记录的所有可用API及其调用文档
62

3+
此文档库为云湖社交目前已发现并被记录的所有可用API及其对应的调用文档,目的便于开发者进行相关二次开发
4+
所有路由需要在最前补全 `https://chat-go.jwzhd.com` 域名后再请求
5+
**所有API信息只做为公开参考**
76
建议提交前先本地预览一下有没有问题
87
命令相关参照vuepress-theme-hope文档
98
补全依赖
10-
```
9+
10+
```SHELL
1111
pnpm install --lockfile
1212
```
13+
1314
启动本地开发服务器
14-
```
15+
16+
```SHELL
1517
pnpm docs:dev
1618
```

src/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ footer: 使用 <a href="https://theme-hope.vuejs.press/zh/" target="_blank">VueP
2424

2525
云湖已发现API及调用的非官方参考文档.目的是方便开发者进行二次开发使用.
2626
**所有API信息只做为公开参考**
27-
**所有API调用请遵循相关法律法规以及云湖的用户协议,本项目仅用于学习研究用途.**
27+
**所有API调用请遵循相关法律法规以及云湖的用户协议,本项目仅用于学习研究用途.**

src/api/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
title: API
33
---
44
## 目录
5+
6+
* 1
7+
58
> **[v1](./v1/)**
69
> -云湖v1目录下已记录的所有API文档
710
11+
* 2
12+
813
> **[wss](./wss/)**
914
> -云湖wss连接已记录的所有连接文档

src/云湖API吐槽/1ctrl-cv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
第二
2-
我待会再来写这个
1+
第二
2+
我待会再来写这个

0 commit comments

Comments
 (0)