417 Commits

Author SHA1 Message Date
Ryan Wang
9fb9fc7014 Update Nginx Proxy Manager install docs and add images (#544) 2025-12-25 18:27:33 +08:00
Howie Xie
ac203d726e fix(getting-started): Fix typos in systemd service config (#541)
fix #536 

```release-note
None
```
2025-12-25 08:37:02 +00:00
Howie Xie
83b38cc1cb fix(developer-guide/form-schema): remove unexpected marks (#540)
fix #539

```release-note
None
```
2025-12-25 08:35:02 +00:00
Howie Xie
79314247be feat(_SiteSettingVo): Add routes config (#542)
fix #538 
ref https://github.com/halo-dev/halo/pull/8045/files#diff-55c6218411dc6cbb107225edb77470825b09b51180f8cbbcc46759c168ef9361
<img width="227" height="138" alt="image" src="https://github.com/user-attachments/assets/10c2b9dc-04dd-45cf-88ec-a9a0bafb00d0" />
<img width="456" height="76" alt="image" src="https://github.com/user-attachments/assets/0eca48e7-3589-47a5-b014-0575c9a7a86e" />

```release-note
None
```
2025-12-25 08:31:01 +00:00
Ryan Wang
248fb41985 Update Docusaurus to 3.9.2 and improve i18n 2025-12-24 18:26:01 +08:00
Ryan Wang
5953f17ed2 docs: update documentations for 2.22 (#537)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-12-24 11:31:37 +08:00
Ryan Wang
8642b4e257 Update docs for attachment form type refactor in 2.22 (#534) 2025-12-21 21:44:40 +08:00
Ryan Wang
bd87bf771f Update form-schema documentation for icon field (#535) 2025-12-21 21:44:19 +08:00
John Niang
654752541a Enhance cursor method documentation with additional info and clarify return types (#533)
* Enhance cursor method documentation with additional info and clarify return types

* Update API changelog to include changes to cursor(postName) return structure
2025-12-20 12:34:13 +08:00
Ryan Wang
e60650da2b Update Iconify form value documentation (#532)
Added detailed explanation of the Iconify form value object, including its properties and usage for different formats. Updated code examples to reference the correct value property.
2025-12-20 12:31:16 +08:00
Howie Xie
0951d78f25 docs(developer-guide/form-schema): Update itemLabels type (#531)
同步 https://github.com/halo-dev/halo/pull/8014

```release-note
None
```
2025-12-16 15:28:07 +00:00
Takagi
26c42e7f2b docs: supplement the editor api change document (#529)
#### What this PR does / why we need it:

补充编辑器 API 变更文档

#### Which issue(s) this PR fixes:

Fixes #514 

#### Does this PR introduce a user-facing change?
```release-note
None
```
2025-12-12 03:23:09 +00:00
Takagi
8cf5aac5a4 docs: Add documentation for new array component in FormKit (#528)
#### What type of PR is this?

为新增的 `array` formkit 组件编写文档。

see https://github.com/halo-dev/halo/pull/7996

#### Does this PR introduce a user-facing change?
```release-note
None
```
2025-12-12 03:19:10 +00:00
Ryan Wang
33beb46cf1 Add Iconify icon selector to FormKit docs (#527) 2025-12-10 16:35:57 +08:00
Howie Xie
99e82aeb3b docs: Update annotations-form.md with checkbox details (#526)
* docs: Update annotations-form.md with checkbox details

Clarified that 'checkbox' input components should use 'on-value' and 'off-value' for string values.

* docs: Update annotations form documentation for checkbox input (#1)
2025-11-27 13:42:55 +08:00
Ryan Wang
44ad38cde3 Cleanup outdated docs (#525)
https://v2.archive-docs.halo.run/

```release-note
None
```
2025-11-13 03:48:45 +00:00
Ryan Wang
cfb0acffcd Rename @halo-dev/console-shared to @halo-dev/ui-shared in docs (#524) 2025-11-11 10:35:39 +08:00
Ryan Wang
714ff91419 Update attachment selector docs for mediaType support (#523) 2025-11-06 21:27:18 +08:00
Ryan Wang
ec157cad60 Add shared utilities API docs for plugins (#522)
* Add shared utilities API docs for plugins

* docs: add dayjs() method to utils section in shared API reference
2025-11-06 18:09:00 +08:00
Ryan Wang
461b7e089e Use shiki as code highlighter (#521) 2025-10-29 18:18:23 +08:00
Ryan Wang
ec35171d48 Update image optimization docs for Halo 2.22 (#520)
Clarified that from Halo 2.22, responsive image attributes are automatically added to all images, reducing the need for manual theme adaptation. Improved API documentation and removed redundant info about article content handling.

Fixes #518 

```release-note
None
```
2025-10-28 06:32:16 +00:00
Takagi
a5b72b6a8e docs: add docs for draggable menu extension point (#517)
* docs: add docs for draggable menu extension point

Revised documentation to reflect the new draggable menu extension API, replacing the previous draggable functionality. Added details and examples for `getDraggableMenuItems`, described menu nesting, and included a new reference image for the draggable menu.

* docs: supplement document

* docs: correct wording for drag menu extension explanation

---------

Co-authored-by: Ryan Wang <i@ryanc.cc>
2025-10-27 18:03:21 +08:00
Ryan Wang
6604671684 docs: add api changelog docs for plugin (#513)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-10-27 18:00:09 +08:00
Ryan Wang
6267192752 Add config options for attachment thumbnails (#512)
* Add config options for attachment thumbnails

Documented new configuration properties to disable attachment thumbnail generation and set concurrent threads for thumbnail creation.

* Add thumbnail quality config option to docs

Documents the new `halo.attachment.thumbnail.quality` configuration for controlling attachment thumbnail generation quality (0-1).
2025-10-27 17:56:38 +08:00
BugKing
4f0a5d275d docs: remove 1panel related content in alibaba-cloud-market (#511)
* docs: remove 1panel related content in alibaba-cloud-market

* docs: remove 1panel related content in alibaba-cloud-market

* Clean up formatting in Alibaba Cloud market doc

Removed an empty line before the bash code block.
2025-09-22 12:05:17 +08:00
Ryan Wang
1234d6c717 Add app publishing guide (#510) 2025-09-05 18:16:50 +08:00
Ryan Wang
0accb42606 Highlight PostgreSQL as recommended database in docs (#509)
```release-note
None
```
2025-08-14 09:26:55 +00:00
付如意
bbb81f1873 Update posts.md (#476)
* Update posts.md

* Update

Signed-off-by: Ryan Wang <i@ryanc.cc>

* Update

Signed-off-by: Ryan Wang <i@ryanc.cc>

---------

Signed-off-by: Ryan Wang <i@ryanc.cc>
Co-authored-by: Ryan Wang <i@ryanc.cc>
2025-08-06 15:09:17 +08:00
Ryan Wang
552146f8a7 chore: remove deploy action step (#508)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-07-03 11:14:42 +08:00
Ryan Wang
90d3104d0d docs: update documentations for plugin development (#504)
```release-note
None
```
2025-06-24 07:15:13 +00:00
Ryan Wang
7e097c93f9 chore: refine plugin development documentation (#503)
* chore: refine plugin development documentation

Signed-off-by: Ryan Wang <i@ryanc.cc>

* chore: refine plugin development documentation

Signed-off-by: Ryan Wang <i@ryanc.cc>

* chore: refine plugin development documentation

Signed-off-by: Ryan Wang <i@ryanc.cc>

---------

Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-06-21 20:47:16 +08:00
Ryan Wang
9df9374ce3 docs: update documentations for 2.21 (#502)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-06-15 14:49:12 +08:00
Ryan Wang
afda4f83bf docs: add documentation for singlePage extension (#501)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-06-15 12:03:18 +08:00
Ryan Wang
04ee260416 docs: add docs for dashboard widgets extension points (#500)
See https://github.com/halo-dev/halo/pull/7496

```release-note
None
```
2025-06-06 08:36:56 +00:00
柳意梧情
02c3d799ce docs: update document for UserLoginEvent and UserLogoutEvent (#497) 2025-05-29 21:13:06 +08:00
Ryan Wang
46143f9c8b chore: bump docusaurus to 3.8 (#498) 2025-05-27 19:15:18 +08:00
songyg
2a04a7eced docs: add Rainbond button (#496)
Co-authored-by: songyg <songyg@goodrain.com>
2025-05-16 11:07:15 +08:00
Ryan Wang
0a7cdc5171 chore: remove umami tracking script (#495)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-05-15 11:08:16 +08:00
Ryan Wang
098e9b339b chore: add rybbit tracking script (#494)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2025-05-14 15:08:02 +08:00
Ryan Wang
1cf9b3636f docs: fix some correct document formatting using autocorrect (#493)
Fix some correct document formatting using [autocorrect](https://github.com/huacnlee/autocorrect)

```release-note
None
```
2025-04-23 03:45:09 +00:00
Ryan Wang
c82df43df2 Update search engine api key 2025-03-02 11:07:54 +08:00
HowieHz
2a08da551f fix: fix API misuse in the sample (#491)
fix #490 

```release-note
None
```
2025-01-11 16:03:52 +00:00
guqing
f3ec38c7d9 chore: update the build.gradle file for the dependent plugin api module (#488)
### What this PR does?

更新插件 api 模块的 build.gradle 增加源码 JAR 配置文档以便让其他依赖者能获取到源码和文档便于开发

```release-note
None
```
2025-01-06 15:31:30 +00:00
Ryan Wang
5a3610dbc0 fix: error link syntax in annotations-form.md (#487)
```release-note
None
```
2025-01-02 08:32:03 +00:00
Ryan Wang
a8c923892f docs: update download links in JAR deployment documentation (#486)
Update download links in JAR deployment documentation

```release-note
None
```
2024-12-17 10:06:10 +00:00
Ryan Wang
0eb010c402 docs: add Zeabur platform deployment documentation link (#481)
添加 Zeabur 平台的部署文档链接。

https://zeabur.com/docs/zh-CN/marketplace/halo

```release-note
None
```
2024-12-16 07:16:09 +00:00
Ryan Wang
3b51bea893 docs: remove page cache config for jar-file document (#485)
移除 Jar 部署方式中配置示例的页面缓存配置,这个配置已经在 2.17+ 移除。

```release-note
None
```
2024-12-16 07:04:08 +00:00
Ryan Wang
22600b7f6f fix: missing example display for ListedPostVo type (#482)
修复 ListedPostVo 类型示例不显示的问题。

Fixes #480 

```release-note
None
```
2024-12-09 11:23:35 +00:00
Ryan Wang
ec9fdde451 fix: correct getByNames method examples for category and tag api (#483)
修复 categoryFinder 和 tagFinder 关于 getByNames 的错误示例。

Fixes https://github.com/halo-dev/docs/issues/475

```release-note
None
```
2024-12-09 11:21:34 +00:00
guqing
ccde5aaee3 docs: add docs for system info getter (#479)
### What this PR does?
新增 SystemInfoGetter 共享 Bean 使用文档

```release-note
None
```
2024-12-05 03:29:12 +00:00