Commit Graph

134 Commits

Author SHA1 Message Date
guqing
eac3f93313 docs: rewrite extension development documentation (#455) 2024-10-31 11:29:44 +08:00
Ryan Wang
4b9a671204 docs: add custom login-related pages documentation (#452)
提供自定义登录相关页面的文档。

/kind documentation

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

```release-note
提供自定义登录相关页面的文档。
```
2024-10-29 08:14:12 +00:00
guqing
f106b52017 docs: add docs for using shared objects within the plugin (#451)
### What this PR does?
完善 Halo 共享给插件的 Beans 列表和使用文档

```release-note
None
```
2024-10-29 02:02:10 +00:00
Ryan Wang
cd44c8ba89 docs: restructure theme development documentation (#450)
重构主题开发的部分文档,合并模板路由和模板变量章节。

/kind documentation

```release-note
None
```
2024-10-28 08:18:05 +00:00
guqing
e4edfed6bc docs: update devtools documents (#446)
### What this PR does?
更新 devtools 使用文档

```release-note
None
```
2024-10-28 06:32:05 +00:00
guqing
fa1fb46d25 refactor: update plugin manifest doc (#448)
### What this PR does?
更新插件描述文件的文档

```release-note
None
```
2024-10-28 06:30:05 +00:00
guqing
57e7c2bc03 refactor: update plugin structure doc (#447)
### What this PR does?

更新插件项目结构文档

```release-note
None
```
2024-10-28 04:04:04 +00:00
guqing
c28767ab09 chore: move framework doc file to core developer dir (#445)
### What this PR does?
将 Halo 架构概览移动到系统开发章节

```release-note
None
```
2024-10-25 13:33:55 +00:00
guqing
717ee402f4 refactor: update permission control docs for plugin (#443)
### What this PR does?
重构权限控制部分文档并调整相应结构

```release-note
None
```
2024-10-25 08:01:56 +00:00
Ryan Wang
bb4ade60ec docs: update basic authentication documentation (#440)
更新关于 Basic Auth 认证的说明。

/kind documentation

```release-note
None
```
2024-10-24 04:09:48 +00:00
guqing
32c8947334 docs: add devtools upgrade guide for 0.2.0 (#434)
### What this PR does?
添加 Devtools 升级到 0.2.0 版本的升级提示

```release-note
None
```
2024-10-15 11:17:22 +00:00
Ryan Wang
5ce83249d2 docs: update halo official website url (#433)
更新 Halo 官网的地址。

```release-note
None
```
2024-10-15 06:31:21 +00:00
Ryan Wang
9876911e3a docs: update documentation for Halo 2.20 (#429)
为 [Halo 2.20](https://github.com/halo-dev/halo/releases/tag/v2.20.0) 更新文档。

/kind documentation

```release-note
None
```
2024-10-14 03:33:15 +00:00
Takagi
d449d7c676 docs: add explanation for formkit select fieldSelectorKey property (#409)
#### What this PR does / why we need it:

为 formkit select 组件的远程搜索,增加 `fieldSelectorKey` 字段的使用说明。

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

#### Does this PR introduce a user-facing change?
```release-note
None
```
2024-09-18 02:46:49 +00:00
Ryan Wang
65018a5955 docs: add documentation for menu select form item (#416)
添加关于 menuSelect 输入类型的文档。

See https://github.com/halo-dev/halo/pull/6642

/kind documentation

```release-note
None
```
2024-09-14 06:38:31 +00:00
Ryan Wang
5608dedd2b docs: add documentation for RESTful API usage (#412)
添加 REST API 的使用文档。

Fixes #326 
Fixes #216 


```release-note
None
```
2024-09-09 09:34:05 +00:00
guqing
3aadde1218 docs: add docs for unified parameter list method of post finder (#411)
### What this PR does?

为 https://github.com/halo-dev/halo/pull/6531 补充文档说明


```release-note
None
```
2024-09-05 04:45:47 +00:00
Takagi
a82e778e05 docs: supplement formkit select document (#410)
#### What this PR does / why we need it:

补充 formkit select 相关文档。

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

Fixes #408 

#### Does this PR introduce a user-facing change?
```release-note
None
```
2024-09-05 04:43:47 +00:00
Ryan Wang
e431bdc99b docs: update documentation for Halo 2.18 (#407)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2024-09-02 14:14:00 +08:00
Ryan Wang
9d7d609216 docs: add image optimization documentation for theme development (#405)
添加主题开发的图片优化文档。

/kind documentation

```release-note
None
```
2024-09-01 15:49:35 +00:00
Takagi
ec52b613b4 docs: update select field selector document (#404)
#### What this PR does / why we need it:

更新 formkit select  组件关于远程加载时的字段

#### Does this PR introduce a user-facing change?
```release-note
None
```
2024-08-26 10:31:15 +00:00
Takagi
b842e6b44a docs: add formkit select component (#400)
#### What this PR does / why we need it:

添加 formkit select 组件的文档

#### Does this PR introduce a user-facing change?
```release-note
None
```
2024-08-26 09:25:14 +00:00
Ryan Wang
250c0180d7 chore: bump docusaurus version to 3.x (#395)
升级 Docusaurus 版本至 3.x

参照 https://docusaurus.io/zh-CN/docs/migration/v3 升级指南。

Fixes #394 

/kind improvement

```release-note
None
```
2024-08-09 14:12:40 +00:00
困困鱼
4a53db88f4 docs: make comment and reply list item operations extendable (#393)
```release-note
None
```
2024-08-09 13:54:39 +00:00
困困鱼
1add3ef3dd docs: refine docs for postFinder.listByOwner (#391)
补充根据创建者用户名和分页参数获取文章列表。

```release-note
None
```
2024-08-09 13:06:40 +00:00
Ryan Wang
dd6cc4848a docs: update documentation for Halo 2.18 (#389)
为 [Halo 2.18](https://github.com/halo-dev/halo/releases/tag/v2.18.0) 更新文档。

/kind documentation

```release-note
None
```
2024-08-01 02:50:10 +00:00
Takagi
017ec7aaa9 docs: add docs for plugin ExtensionGetter (#388)
#### What this PR does / why we need it:

添加 ExtensionGetter 的开发者文档及示例。

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

#### Does this PR introduce a user-facing change?
```release-note
None
```
2024-07-26 02:27:39 +00:00
guqing
c565125540 docs: add docs for getBreadcrumbs of category finder (#384)
### What this PR does?
为分类 Finder API 新增的 getBreadcrumbs 方法提供文档

see also https://github.com/halo-dev/halo/pull/6135

```release-note
None
```
2024-07-04 15:22:33 +00:00
Ryan Wang
1714c0f496 docs: add documentations for plugin detail modal component (#385)
添加 2.17.0 添加的 PluginDetailModal 组件的文档。

/kind documentation

```release-note
None
```
2024-07-02 15:47:25 +00:00
guqing
b2bab07578 docs: add docs for login handler enhancer (#382)
### What this PR does?
增加关于 LoginHandlerEnhancer 的使用文档

see also https://github.com/halo-dev/halo/pull/6176

```release-note
None
```
2024-07-02 04:53:23 +00:00
guqing
daf93fb72c docs: add docs for check plugin availability by version (#383)
### What this PR does?
添加插件 Finder API 中通过插件名称和版本判断某插件是否可用的 API 的文档

see also https://github.com/halo-dev/halo/pull/6236

```release-note
None
```
2024-07-02 04:51:23 +00:00
guqing
b125e02d8d docs: add docs for template footer processor (#381)
### What this PR does?
为 TemplateFooterProcessor 添加开发文档

see also https://github.com/halo-dev/halo/pull/6191

```release-note
None
```
2024-07-02 04:27:22 +00:00
guqing
9b87090a9b docs: add docs for list options builder (#380)
### What this PR does?
添加 ListOptions builder 的文档说明

see also https://github.com/halo-dev/halo/pull/6148

```release-note
None
```
2024-07-02 03:49:22 +00:00
guqing
59096a9e4b chore: remove deprecated plugin wrapper (#379)
### What this PR does?
移除已经过时的 PluginWrapper 引用

```release-note
None
```
2024-07-02 03:25:22 +00:00
Ryan Wang
9d868fa50e docs: update documentation for Halo 2.17 (#378)
为 [Halo 2.17](https://github.com/halo-dev/halo/releases/tag/v2.17.0) 更新文档。

/kind documentation

```release-note
None
```
2024-07-02 02:41:22 +00:00
Ryan Wang
d61ebe4f62 docs: add api client usage docs for plugin (#374)
为插件提供 api-client 的使用文档。

/kind documentation

```release-note
None
```
2024-07-02 02:19:24 +00:00
guqing
bb324eddda docs: add guide for customize and build controller (#376)
### What this PR does?
补充关于定制和构建控制器的文档

see also https://github.com/halo-dev/halo/pull/6145

```release-note
None
```
2024-06-28 07:22:59 +00:00
guqing
70d9c65698 docs: add detailed guide on how to use plugin settings (#375)
### What this PR does?
新增关于如何使用插件配置的文档

see also https://github.com/halo-dev/halo/pull/6141

```release-note
None
```
2024-06-28 07:04:58 +00:00
Takagi
976fcd9576 docs: add dynamic list doc (#373)
增加 formkit list 的文档。

/kind documentation

```release-note
None
```
2024-06-26 06:16:49 +00:00
Ryan Wang
9c89e60116 docs: update pnpm version require (#371)
/kind documentation

```release-note
None
```
2024-06-20 01:25:00 +00:00
Ryan Wang
de60c8a3fd chore: improve importing markdown file name (#368)
为被导入的 Markdown 片段文件名添加 `_`,防止为其生成页面。比如:https://docs.halo.run/developer-guide/theme/vo/ThemeVo

参考文档:https://docusaurus.io/docs/2.x/markdown-features/react#importing-markdown

/kind improvement

```release-note
None
```
2024-06-03 06:35:44 +00:00
Ryan Wang
7eec30763e docs: update documentation for Halo 2.16 (#367)
为 Halo 2.16.0 更新文档。

/kind documentation

```release-note
None 
```
2024-06-03 04:45:44 +00:00
Ryan Wang
07e7417c83 fix: broken links (#366)
修复异常链接。

```release-note
None
```
2024-05-29 10:21:12 +00:00
Ryan Wang
8846344ca8 typo: 登陆 -> 登录 (#364)
更新文案:登陆 -> 登录

/kind documentation

```release-note
None
```
2024-05-29 08:09:11 +00:00
BugKing
18b4ee061f fix: total pages in archives.html sample (#363)
```release-note
None
```
2024-05-29 07:57:11 +00:00
apanonar
f995b1a5ae docs: update document of plugin example (#361)
修改插件开发案例文档,来匹配最新的 [plugin-starter](https://github.com/halo-dev/plugin-starter)。

```release-note
None
```
2024-05-28 14:07:06 +00:00
mashirot
f74035fc49 feat: modify ui service startup way (#350)
```release-note
修改 UI 服务启动方式为直接从 pnpm 启动
```
2024-05-17 07:42:37 +00:00
guqing
8df5dcf9e9 refactor: role template docs (#353)
### What this PR does?
重写 API 权限控制的文档以减小用户理解成本


```release-note
None
```
2024-05-16 05:02:35 +00:00
Ryan Wang
fc626d152c docs: remove colorScheme param for halo:comment tag (#352)
移除文档中关于 `halo:comment` 标签的 colorScheme 字段,这是以前的设计错误,此模板引擎标签不应该涉及最终 UI 相关的功能。目前官方的评论插件已经支持通过 CSS 变量来改变配色和其他样式。

/kind documentation

```release-note
None
```
2024-05-16 03:48:35 +00:00
guqing
b8b5a4e34d doc: add doc for template head processor extension point (#348) 2024-05-08 16:10:19 +08:00