Skip to content

Commit 8372f64

Browse files
committed
docs: 修正文档格式
1 parent a722360 commit 8372f64

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

docs/en_us/9.1-MaaHttp.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ This project is the HTTP binding of MaaFramework. It provides the corresponding
99
MaaHttp provides a master-slave multiprocess mode. By default, launching MaaHttp let it enter master mode. This process won't provide interface of MaaFramework. Instead, it provides the ability to create, destroy slave. The created slave would provide interface of MaaFramework.
1010

1111
```bash
12-
PS E:\Projects\MAA\MaaFramework> .\build\bin\Debug\MaaHttp.exe
12+
./bin/MaaHttp
1313
deamon started at 127.0.0.1:13126
1414
```
1515

1616
Meanwhile, you can directly launch MaaHttp in the slave mode, via `-s` option. The serving port will be printed.
1717

1818
```bash
19-
PS E:\Projects\MAA\MaaFramework> .\build\bin\Debug\MaaHttp.exe -s
19+
./bin/MaaHttp -s
2020
57243
2121
```
2222

docs/zh_cn/9.1-MaaHttp.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# MaaHttp
22

3-
该项目是MaaFramework的HTTP绑定。该项目提供了与大部分MaaFramework的C接口对应的HTTP请求
3+
该项目是 MaaFramework 的 HTTP 绑定。该项目提供了与大部分 MaaFramework 的 C 接口对应的 HTTP 请求
44

55
## 主从模式
66

7-
MaaHttp提供了一个主从多进程模式。默认情况下,执行MaaHttp将会以主模式启动。该进程不会提供MaaFramework的接口,而是提供创建、销毁从进程的能力。创建的从进程会提供MaaFramework的接口
7+
MaaHttp 提供了一个主从多进程模式。默认情况下,执行 MaaHttp 将会以主模式启动。该进程不会提供 MaaFramework 的接口,而是提供创建、销毁从进程的能力。创建的从进程会提供 MaaFramework 的接口
88

99
```bash
10-
PS E:\Projects\MAA\MaaFramework> .\build\bin\Debug\MaaHttp.exe
10+
./bin/MaaHttp
1111
deamon started at 127.0.0.1:13126
1212
```
1313

14-
同时,你也可以直接通过`-s`选项以从模式启动MaaHttp。会打印出提供服务的端口。
14+
同时,你也可以直接通过 `-s` 选项以从模式启动 MaaHttp。会打印出提供服务的端口。
1515

1616
```bash
17-
PS E:\Projects\MAA\MaaFramework> .\build\bin\Debug\MaaHttp.exe -s
17+
./bin/MaaHttp -s
1818
57243
1919
```
2020

21-
通过`-p [port]`选项,你可以指定提供服务的端口。默认情况下,主模式会使用`13126`,从模式会自动选择一个可用端口。
21+
通过 `-p [port]` 选项,你可以指定提供服务的端口。默认情况下,主模式会使用 `13126`,从模式会自动选择一个可用端口。
2222

2323
## OpenAPI
2424

25-
主模式和从模式服务器均在`/help`路径提供了其OpenAPI 3.0文档
25+
主模式和从模式服务器均在 `/help` 路径提供了其 OpenAPI 3.0 文档
2626

2727
## 主模式
2828

2929
### `/cfgread` and `/cfgwrite`
3030

31-
这两个路径提供了加载和存储一个json对象的能力,其存储在`MaaHttpConfig.json`中。
31+
这两个路径提供了加载和存储一个 json 对象的能力,其存储在 `MaaHttpConfig.json` 中。
3232

3333
### `/create`
3434

@@ -40,37 +40,37 @@ PS E:\Projects\MAA\MaaFramework> .\build\bin\Debug\MaaHttp.exe -s
4040

4141
### `/heart`
4242

43-
通知某一个从进程仍然在使用。MaaHttp每60秒检查所有的从进程,销毁超过30s未通知的从进程
43+
通知某一个从进程仍然在使用。MaaHttp 每 60 秒检查所有的从进程,销毁超过 30s 未通知的从进程
4444

4545
## 从模式
4646

4747
### `/api/*`
4848

49-
MaaFramework的函数
49+
MaaFramework 的函数
5050

51-
注意:某些函数会返回多个结果,因此不要简单的提取出`return`键。
51+
注意:某些函数会返回多个结果,因此不要简单的提取出 `return` 键。
5252

5353
### `/handle/[HANDLE]/strip`
5454

55-
清理所有的临时`HANDLE`句柄。
55+
清理所有的临时 `HANDLE` 句柄。
5656

57-
目前,只有`MaaGetImageListAt`使用这个能力。该函数返回的句柄不由MaaHttp管理,因此只提供了其的弱引用。
57+
目前,只有 `MaaGetImageListAt` 使用这个能力。该函数返回的句柄不由 MaaHttp 管理,因此只提供了其的弱引用。
5858

5959
### `/handle/[HANDLE]/dump`
6060

61-
导出所有`HANDLE`句柄,用于调试。
61+
导出所有 `HANDLE` 句柄,用于调试。
6262

6363
### `/callback/[CALLBACK]/new`
6464

65-
创建一个新的`CALLBACK`回调实例。返回的字符串就是这个回调的句柄,用于传递给`MaaCreate`等函数。
65+
创建一个新的 `CALLBACK` 回调实例。返回的字符串就是这个回调的句柄,用于传递给 `MaaCreate` 等函数。
6666

6767
### `/callback/[CALLBACK]/free`
6868

6969
释放一个`CALLBACK`回调实例。
7070

7171
### `/callback/[CALLBACK]/query`
7272

73-
查询某一个`CALLBACK`回调实例的所有的调用实例。该路径会阻塞,直到超过5秒或有新的调用实例发生
73+
查询某一个 `CALLBACK` 回调实例的所有的调用实例。该路径会阻塞,直到超过 5 秒或有新的调用实例发生
7474

7575
注意:调用实例不会在被查询后移除,因此如果你不提前处理的话,你可能会得到重复的实例。
7676

@@ -82,8 +82,8 @@ MaaFramework的函数。
8282

8383
### `/callback/[CALLBACK]/res`
8484

85-
设置某一个调用实例对应的返回值。该路径结束后,调用实例会被移除且不会被query返回
85+
设置某一个调用实例对应的返回值。该路径结束后,调用实例会被移除且不会被 query 返回
8686

8787
### `/callback/[CALLBACK]/dump`
8888

89-
导出所有`CALLBACK`回调实例,用于调试。
89+
导出所有 `CALLBACK` 回调实例,用于调试。

0 commit comments

Comments
 (0)