Commit Graph

402 Commits

Author SHA1 Message Date
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
guqing
8a0e508304 fix: correct plugin dependency description (#478)
### What this Pr does?
修复插件依赖声明文档描述不正确的问题

```release-note
None
```
2024-12-04 09:45:11 +00:00
Ryan Wang
ec9331cbcc docs: update postCount field in category vo and tag vo (#477)
统一分类和标签的文章数量字段。

See https://github.com/halo-dev/halo/issues/7095

```release-note
None
```
2024-12-04 09:39:10 +00:00
Ryan Wang
d0373d3db5 docs: remove lastLoginAt field from UserVo (#472)
移除 UserVo 类型示例中的 lastLoginAt 字段,目前这个字段并没有使用。

```release-note
None
```
2024-11-20 03:28:08 +00:00
Ryan Wang
002d1f472d chore: bump docusaurus to 3.6.2 (#471)
升级 Docusaurus 至 3.6.2,以修复开发环境无法启动的问题。

```release-note
None
```
2024-11-20 03:26:07 +00:00
guqing
905e121b85 docs: add doc on defining and declaring extension points for plugin extensibility (#470)
### What this PR does?

提供插件如何被扩展的文档

```release-note
None
```
2024-11-16 03:36:01 +00:00
guqing
a21748cce5 docs: add shared events document for developer (#468)
### What this PR does?
添加共享事件文档

```release-note
None
```
2024-11-14 08:30:03 +00:00
Ryan Wang
adc8202762 chore: update OWNERS (#469)
* chore: update OWNERS

* Update OWNERS
2024-11-13 18:46:17 +08:00
guqing
c40c587bf2 docs: add plugin dependencies docs (#467)
### What this PR does?
新增插件依赖开发文档

```release-note
None
```
2024-11-12 09:08:00 +00:00
Ryan Wang
86b9b26d38 typo: resrouces to resources (#466)
```release-note
None
```
2024-11-07 03:47:30 +00:00
guqing
da39e579d0 refactor: update document for devtools (#465)
### What this PR does?
更新 Devtools 文档

```release-note
None
```
2024-11-05 09:22:55 +00:00
Ryan Wang
48c094d1be docs: update documentation for using Alibaba Cloud ECS Halo image (#463)
更新使用阿里云镜像部署 Halo 的文档。


```release-note
None
```
2024-11-01 10:20:49 +00:00
guqing
00741fee5c fix: aggregate role docs (#464) 2024-11-01 17:48:07 +08:00
guqing
92551b7d2d docs: add document for notification (#462)
### What this PR does?
新增通知功能相关开发文档

```release-note
None
```
2024-11-01 01:50:44 +00:00
Ryan Wang
aa466d9b72 chore: bump docusaurus to canary verison (#428)
Support for building projects via rspack has been added in the latest Canary version of Docusaurus, which significantly improves compilation speed. 

```bash
❯ hyperfine --prepare 'pnpm clear' --runs 5 'DOCUSAURUS_FASTER=false pnpm build' 'DOCUSAURUS_FASTER=true pnpm build'
Benchmark 1: DOCUSAURUS_FASTER=false pnpm build
  Time (mean ± σ):     70.715 s ± 17.150 s    [User: 134.096 s, System: 31.651 s]
  Range (min … max):   52.330 s … 88.497 s    5 runs

Benchmark 2: DOCUSAURUS_FASTER=true pnpm build
  Time (mean ± σ):     30.094 s ±  4.572 s    [User: 64.061 s, System: 28.384 s]
  Range (min … max):   25.832 s … 37.655 s    5 runs

Summary
  DOCUSAURUS_FASTER=true pnpm build ran
    2.35 ± 0.67 times faster than DOCUSAURUS_FASTER=false pnpm build
```

see: https://github.com/facebook/docusaurus/issues/10556#issuecomment-2407671873

```release-note
None 
```
2024-10-31 09:48:01 +00:00
Ryan Wang
c03925c907 docs: add file.encoding parameter for jar deployment document (#460)
Fixes #457 

```release-note
None
```
2024-10-31 08:23:07 +00:00