Skip to content

Commit 1cf9b36

Browse files
authored
docs: fix some correct document formatting using autocorrect (#493)
Fix some correct document formatting using [autocorrect](https://github.com/huacnlee/autocorrect) ```release-note None ```
1 parent c82df43 commit 1cf9b36

70 files changed

Lines changed: 166 additions & 166 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/contribution/pr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: 代码贡献指南
1313

1414
> 这个步骤非常适合首次贡献者。
1515
16-
[halo-dev](https://github.com/halo-dev)[halo-sigs](https://github.com/halo-sigs) 组织下,有非常多的仓库。每个仓库下都有可能包含一些“首次贡献者”友好的 Issue,主要是为了给贡献者提供一个友好的体验。 该类 Issue
16+
[halo-dev](https://github.com/halo-dev)[halo-sigs](https://github.com/halo-sigs) 组织下,有非常多的仓库。每个仓库下都有可能包含一些“首次贡献者”友好的 Issue,主要是为了给贡献者提供一个友好的体验。该类 Issue
1717
一般会用 `good-first-issue` 标签标记。标签 `good-first-issue` 表示该 Issue 不需要对 Halo 有深入的理解也能够参与。
1818

1919
请点击:[good-first-issue](https://github.com/issues?q=org%3Ahalo-dev+is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+no%3Aassignee+)

docs/developer-guide/core/structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ description: Halo 项目的构成
2727
- classpath:/config/
2828
- classpath:/
2929

30-
> 参考: [Application Property Files](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files)
30+
> 参考[Application Property Files](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files)
3131
3232
在开发的时候,希望大家能够在 `~/halo-dev/application.yml` 中进行添加自定义配置。当然后面也会讲到如何用`运行参数``VM options` 进行控制配置,届时可根据具体情况进行选择。
3333

docs/developer-guide/form-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ spec:
7777

7878
- `options`:静态数据源。当 `action` 存在时,此参数无效。
7979
- `action`:远程动态数据源的接口地址。
80-
- `requestOption` 动态数据源的请求参数,可以通过此参数来指定如何获取数据,适配不同的接口。当 `action` 存在时,此参数有效。
80+
- `requestOption`:动态数据源的请求参数,可以通过此参数来指定如何获取数据,适配不同的接口。当 `action` 存在时,此参数有效。
8181
- `remoteOptimize`:是否开启远程数据源优化,默认为 `true`。开启后,将会对远程数据源进行优化,减少请求次数。仅在动态数据源下有效。
8282
- `allowCreate`:是否允许创建新选项,默认为 `false`。仅在静态数据源下有效,需要同时开启 `searchable`。
8383
- `clearable`:是否允许清空选项,默认为 `false`。

docs/developer-guide/plugin/api-reference/server/extension.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,13 +253,13 @@ Halo 默认会为每个自定义模型建立以下几个索引,因此不需要
253253
- 必须以字母数字字符开头和结尾。
254254
- 可以包含 `-`、`.`、`_` 和`字母数字`字符。
255255

256-
通用规范:
256+
通用规范
257257

258258
- 避免使用容易引起混淆或误解的键名。
259259
- 尽量保持简洁明了,易于理解。
260260
- 使用易于记忆和识别的单词或缩写。
261261

262-
一致性和清晰性:
262+
一致性和清晰性
263263

264264
- 在整个项目或组织中保持一致的命名约定。
265265
- labels 应直观地反映其代表的信息或用途。
@@ -356,7 +356,7 @@ RouterFunction<ServerResponse> route = route()
356356

357357
这样开发者可以灵活定义符合业务需求的 APIs,方便地扩展插件的功能。
358358

359-
自定义 APIs 与自动生成的 APIs 一样,都应该遵循以下规范:
359+
自定义 APIs 与自动生成的 APIs 一样,都应该遵循以下规范
360360

361361
`/apis/<group>/<version>/<extension>/{extensionname}/<subextension>`
362362

@@ -631,7 +631,7 @@ public static BindingResult validate(Object target, String objectName,
631631
}
632632
```
633633

634-
参考文档:
634+
参考文档
635635

636636
- [RequestBodyValidationException](https://github.com/halo-dev/halo/blob/25086ee3e63f0c8b6ed380140a068c44404ef2b2/application/src/main/java/run/halo/app/infra/exception/RequestBodyValidationException.java)
637637
- [Bean Validation](https://beanvalidation.org/)

docs/developer-guide/plugin/api-reference/server/login-handler-enhancer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 了解如何在登录时如何允许 Halo 做登录逻辑的增强
55

66
## 背景
77

8-
在 Halo 中,插件可以实现多种登录方式,例如LDAP、第三方登录等。然而,灵活的登录方式也带来了以下问题:
8+
在 Halo 中,插件可以实现多种登录方式,例如 LDAP、第三方登录等。然而,灵活的登录方式也带来了以下问题:
99

1010
1. 登录逻辑难以统一:例如登录成功后需要进行额外处理,这需要插件自行实现。
1111
2. Halo 或其他插件无法知晓登录状态:无法记录登录日志等额外处理。

docs/developer-guide/plugin/api-reference/server/notification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Halo 提供了 `NotificationReasonEmitter` 接口,开发者可以通过它轻
284284
- `reasonType`:事件类型的名称,对应于 `ReasonType` 的 `metadata.name` 字段。
285285
- `reasonData`:事件数据的构建器,用于构建 `Reason` 实例的属性。
286286

287-
Reason 数据的构建器有以下属性:
287+
Reason 数据的构建器有以下属性
288288

289289
```java
290290
public class ReasonPayloadBuilder {

docs/developer-guide/plugin/api-reference/server/reconciler.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ description: 了解如何为自定义模型编写控制器
1515
这是一个描述控制器作用的例子:房间里的温度自动调节器。
1616

1717
当你设置了温度,告诉了温度自动调节器你的期望状态(Desired State)。
18-
房间的实际温度是当前状态(Current State)。 通过对设备的开关控制,温度自动调节器让其当前状态接近期望状态,未到达期望状态则继续调节,直到达到期望状态。
18+
房间的实际温度是当前状态(Current State)。通过对设备的开关控制,温度自动调节器让其当前状态接近期望状态,未到达期望状态则继续调节,直到达到期望状态。
1919

2020
在 Halo 中控制器的运行部分已经有一个默认实现,你只需要编写控制器的调谐的逻辑也就是 [控制器概述](../../../core/framework.md#controller) 中的所说的 Reconciler 即可。
2121

@@ -164,10 +164,10 @@ record Result(boolean reEnqueue, Duration retryAfter) {}
164164

165165
### 场景:事件管理系统
166166

167-
创建一个名为 ”EventTracker“ 的自定义模型,用于管理和追踪组织内的各种事件。这些事件可以是会议、研讨会、社交聚会或任何其他类型的组织活动。
168-
“EventTracker“ 自定义模型将提供一个框架,用于记录事件的详细信息,如时间、地点、参与者和状态。
167+
创建一个名为”EventTracker“的自定义模型,用于管理和追踪组织内的各种事件。这些事件可以是会议、研讨会、社交聚会或任何其他类型的组织活动。
168+
“EventTracker“自定义模型将提供一个框架,用于记录事件的详细信息,如时间、地点、参与者和状态。
169169

170-
由于这里的重点是控制器,因此我们将忽略自定义模型的详细信息,只关注控制器的实现,一个可能的 “EventTracker” 数据结构如下:
170+
由于这里的重点是控制器,因此我们将忽略自定义模型的详细信息,只关注控制器的实现,一个可能的“EventTracker”数据结构如下
171171

172172
```yaml
173173
apiVersion: tracker.halo.run/v1alpha1

docs/developer-guide/plugin/api-reference/server/reverseproxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ description: 了解如何使用静态资源代理来访问插件中的静态资
2525
```
2626
2727
插件启动后会根据 `/plugins/{plugin-name}/assets/**` 规则生成访问路径,
28-
因此该 `ReverseProxy` 的访问路径为: `/plugins/my-plugin/assets/res/halo.jpg`
28+
因此该 `ReverseProxy` 的访问路径为`/plugins/my-plugin/assets/res/halo.jpg`。
2929

3030
- `rules` 下可以添加多组规则。
3131
- `path` 为路径前缀。

docs/developer-guide/plugin/api-reference/server/websocket.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ public class MyWebSocketEndpoint implements WebSocketEndpoint {
3737
}
3838
```
3939

40-
当插件安装成功后,可以通过路径 `/apis/my-plugin.halowrite.com/v1alpha1/resources` 访问。 示例如下:
40+
当插件安装成功后,可以通过路径 `/apis/my-plugin.halowrite.com/v1alpha1/resources` 访问。示例如下:
4141

4242
```bash
4343
websocat --basic-auth admin:admin ws://127.0.0.1:8090/apis/my-plugin.halowrite.com/v1alpha1/resources
4444
```
4545

46-
需要注意的是, 插件中实现的 WebSocket 相关的 API 仍然受当前权限系统约束。
46+
需要注意的是,插件中实现的 WebSocket 相关的 API 仍然受当前权限系统约束。

docs/developer-guide/plugin/api-reference/ui/components/uppy-upload.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ const groupName = ref('my-test-group')
3030
| `meta` | Record\<string, unknown\> | undefined | 可选,要发送的额外元数据。 |
3131
| `autoProceed` | boolean | false | 可选,在某些操作后自动继续。 |
3232
| `allowedMetaFields` | string[] | undefined | 可选,指定允许的元数据字段。 |
33-
| `endpoint` | string | 无,必填 | 数据发送到的端点URL|
33+
| `endpoint` | string | 无,必填 | 数据发送到的端点 URL|
3434
| `name` | string | file | 可选,用于上传的表单字段的名称。 |
3535
| `note` | string | undefined | 可选,任何备注或描述。 |
36-
| `method` | "GET" \| "POST" \| "PUT" \| "HEAD" \| "get" \| "post" \| "put" | post | 可选,用于请求的HTTP方法|
36+
| `method` | "GET" \| "POST" \| "PUT" \| "HEAD" \| "get" \| "post" \| "put" | post | 可选,用于请求的 HTTP 方法|
3737
| `disabled` | boolean | false | 可选,如果为真,则禁用组件。 |
3838
| `width` | string | 750px | 可选,组件的宽度。 |
3939
| `height` | string | 550px | 可选,组件的高度。 |

0 commit comments

Comments
 (0)