Commit Graph

431 Commits

Author SHA1 Message Date
Enita
ed414eef99 Update JAR deployment docs for custom work directory (#484)
* a possible solution for #474

* Update jar-file.md

* sync
2026-01-07 21:21:06 +08:00
Ryan Wang
e1625289e8 Add auto backup and sync section to backup guide (#551) 2026-01-07 18:41:35 +08:00
Takagi
2965ab4755 docs: add switch formkit component (#550)
#### What this PR does / why we need it:

补充 `Switch` 组件的文档。

Ref https://github.com/halo-dev/halo/pull/8095

See #543 
#### Does this PR introduce a user-facing change?
```release-note
补充 `Switch` 组件的文档。
```
2026-01-06 15:13:47 +00:00
Ryan Wang
35fa8cc582 Add shop user guide (#549)
* Add shop user guide

* Update shop docs with payment and route info

* Add WeChat Pay setup instructions to payments guide

* Revise WeChat payment setup instructions

Updated instructions for obtaining merchant ID, API key, API certificate, and WeChat AppID.

* Update payment and sales channel documentation

* Refine shop user guide documentation wording

* Add payment preview images and docs for new methods

* Add shop documentation for products, orders, and theme

* Update theme development docs with template resources

* Update product management guide and add images

* Update order management guide with images and details

* Update shop docs for payments and product variants

* Add descriptions to shop guide docs

* Add shop user guide and sidebar category

---------

Co-authored-by: BugKing <wangzhen@fit2cloud.com>
2026-01-06 15:32:07 +08:00
Ryan Wang
0aad18f542 Add wrangler.jsonc configuration file
Introduces a wrangler.jsonc file with project name, compatibility date, and assets directory configuration for deployment.
2026-01-05 12:34:48 +08:00
John Niang
cee6c8806e Add spec.requires change (#548)
* Add spec.requires change

* Update docs/developer-guide/plugin/api-changelog.md

* Update versioned_docs/version-2.22/developer-guide/plugin/api-changelog.md

---------

Co-authored-by: Ryan Wang <i@ryanc.cc>
2026-01-04 23:44:41 +08:00
Ryan Wang
bde7ad27e2 Fix typo in PluginDetailModal documentation
Corrected a typo in the description of the PluginDetailModal component documentation, replacing '差价' with '插件' for accuracy across all relevant documentation versions.
2026-01-04 23:17:59 +08:00
Ryan Wang
aee2b12d58 Update code block language to groovy in docs
Changed code block language from 'gradle' to 'groovy' in plugin API changelog documentation for better syntax highlighting and clarity.
2026-01-04 23:11:05 +08:00
John Niang
6a7a1ea04c Add plugin development notes for Halo 2.22.5 (#547) 2026-01-04 23:02:29 +08:00
Ryan Wang
ad0523b73c Remove sponsorship section from intro docs 2025-12-31 18:22:41 +08:00
Ryan Wang
27794a9ad9 Update docs for Halo Paid version (#546)
* Update docs for Halo Paid version

* Update docs/getting-started/prepare.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update docs/getting-started/install/slots/_docker-registry-list.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add brand settings section to user guide

* Add user guide for license activation

* Add SMS notification configuration guide

* Update lxware.cn links with referral code

* Update user guide for new auth providers and features

* Add Redis integration guide for paid version

* Add license activation instructions to install docs

* Fix broken link to paid version in Redis section

* Fix broken link to release versions in JAR install docs

* Fix link anchor in Finder API changelog docs

* Update issue reporting guidelines in documentation

* Remove sponsor documentation and related references

* Add warning about backup limitations for commercial version

* Update app store guide for license activation changes

* Update docs for Halo 2.22 paid edition and license activation

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-30 21:40:38 +08:00
Ryan Wang
f45a80da75 Update settings docs with new attachment options (#545) 2025-12-29 22:08:20 +08:00
Ryan Wang
ec359ae704 Update Chinese translations and copyright year 2025-12-29 16:21:15 +08:00
Ryan Wang
5be77f05b4 Update copyright year and minor config formatting 2025-12-29 14:45:10 +08:00
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