Skip to content

Commit eac3f93

Browse files
authoredOct 31, 2024··
docs: rewrite extension development documentation (#455)
1 parent 97f7aba commit eac3f93

File tree

10 files changed

+1070
-300
lines changed

10 files changed

+1070
-300
lines changed
 

‎docs/developer-guide/annotations-form.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ spec:
3636

3737
字段说明:
3838

39-
1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#metadata-name),为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
39+
1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#naming-spec-for-metadata-name),为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
4040
2. `spec.targetRef`:模型的关联,即为哪个模型添加元数据表单,目前支持的模型可查看下方的列表。
4141
3. `spec.formSchema`:表单的定义,使用 FormKit Schema 来定义。虽然我们使用的 YAML,但与 FormKit Schema 完全一致。
4242

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public PersonService {
100100

101101
我们建议你更多的使用响应式的 `ReactiveExtensionClient` 去替代 `ExtensionClient`
102102

103-
### 查询
103+
### 查询 {#query}
104104

105105
`ReactiveExtensionClient` 提供了两个方法用于查询数据,`listBy``listAll`
106106

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

+527-142
Large diffs are not rendered by default.

‎docs/developer-guide/plugin/basics/devtools.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ API client 是一种工具或库,旨在简化前端应用程序与后端服务
215215

216216
- 提高开发效率:通过使用 API 客户端,开发者可以专注于业务逻辑的实现,而不用关心底层的 HTTP 细节。这不仅提高了开发效率,还减少了代码冗余。
217217

218-
#### 如何生成 API client
218+
#### 如何生成 API client {#how-to-generate-api-client}
219219

220220
本插件提供了一个 `generateApiClient` 任务,用于为插件项目生成 API client,生成规则基于 OpenAPI 规范来自动生成客户端代码。
221221

‎docs/developer-guide/plugin/security/role-template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ rules:
131131

132132
1. 定义了一个用于管理 Person 自定义模型对象的角色模板 `my-plugin-role-manage-persons`,它具有所有权限。
133133
2. 定义了一个只允许查询 Person 资源的角色模板 `my-plugin-role-view-persons`。
134-
3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#metadata-name)。
134+
3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#naming-spec-for-metadata-name)。
135135

136136
下面让我们回顾一下这些配置:
137137

‎versioned_docs/version-2.20/developer-guide/annotations-form.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ spec:
3636

3737
字段说明:
3838

39-
1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#metadata-name),为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
39+
1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#naming-spec-for-metadata-name,为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
4040
2. `spec.targetRef`:模型的关联,即为哪个模型添加元数据表单,目前支持的模型可查看下方的列表。
4141
3. `spec.formSchema`:表单的定义,使用 FormKit Schema 来定义。虽然我们使用的 YAML,但与 FormKit Schema 完全一致。
4242

‎versioned_docs/version-2.20/developer-guide/plugin/api-reference/server/extension-client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public PersonService {
100100

101101
我们建议你更多的使用响应式的 `ReactiveExtensionClient` 去替代 `ExtensionClient`
102102

103-
### 查询
103+
### 查询 {#query}
104104

105105
`ReactiveExtensionClient` 提供了两个方法用于查询数据,`listBy``listAll`
106106

‎versioned_docs/version-2.20/developer-guide/plugin/api-reference/server/extension.md

+527-142
Large diffs are not rendered by default.

‎versioned_docs/version-2.20/developer-guide/plugin/basics/devtools.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ plugins {
3434

3535
```shell
3636
=======================================================================
37-
> Halo 启动成功!
38-
访问地址:http://localhost:8090/console?language=zh-CN
39-
用户名:admin
40-
密码:admin
41-
API 文档:http://localhost:8090/swagger-ui.html
37+
> Halo 启动成功!
38+
访问地址:http://localhost:8090/console?language=zh-CN
39+
用户名:admin
40+
密码:admin
41+
API 文档:http://localhost:8090/swagger-ui.html
4242
插件开发文档:https://docs.halo.run/developer-guide/plugin/introduction
4343
=======================================================================
4444
```
@@ -117,8 +117,8 @@ halo {
117117
```yaml
118118
# workplace/config/application.yaml
119119
logging:
120-
level:
121-
run.halo.app: DEBUG
120+
level:
121+
run.halo.app: DEBUG
122122
```
123123
124124
更多配置项请参考 [Halo 配置列表](../../../getting-started/install/config.md#配置列表)。
@@ -215,7 +215,7 @@ API client 是一种工具或库,旨在简化前端应用程序与后端服务
215215

216216
- 提高开发效率:通过使用 API 客户端,开发者可以专注于业务逻辑的实现,而不用关心底层的 HTTP 细节。这不仅提高了开发效率,还减少了代码冗余。
217217

218-
#### 如何生成 API client
218+
#### 如何生成 API client {#how-to-generate-api-client}
219219

220220
本插件提供了一个 `generateApiClient` 任务,用于为插件项目生成 API client,生成规则基于 OpenAPI 规范来自动生成客户端代码。
221221

@@ -421,5 +421,5 @@ halo {
421421

422422
```shell
423423
# 如将 Gradle 版本升级至 8.9
424-
./gradlew wrapper --gradle-version=8.9
424+
./gradlew wrapper --gradle-version=8.9
425425
```

‎versioned_docs/version-2.20/developer-guide/plugin/security/role-template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ rules:
131131

132132
1. 定义了一个用于管理 Person 自定义模型对象的角色模板 `my-plugin-role-manage-persons`,它具有所有权限。
133133
2. 定义了一个只允许查询 Person 资源的角色模板 `my-plugin-role-view-persons`。
134-
3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#metadata-name)。
134+
3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#naming-spec-for-metadata-name)。
135135

136136
下面让我们回顾一下这些配置:
137137

0 commit comments

Comments
 (0)
Please sign in to comment.