Commit Graph

304 Commits

Author SHA1 Message Date
BugKing
64d482f224 docs: update tencent-cloud-lighthouse.md (#387)
```release-note
None
```
2024-07-11 04:07:24 +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
BugKing
bf152a8458 docs: 增加离线部署文档 (#386) 2024-07-03 13:15:29 +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
Ryan Wang
6817d813da docs: remove halo.cache.page.disabled arg (#377)
移除部署文章的 `halo.cache.page.disabled` 参数,在 2.17 中已经[移除此功能](https://github.com/halo-dev/halo/pull/6108),后续将由 https://github.com/halo-sigs/plugin-page-cache 提供此功能。

/kind documentation

```release-note
None
```
2024-07-01 08:35:17 +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
05c4dc2089 docs: remove tips related to mariadb driver (#372)
使用 MariaDB 原生驱动无法启动的问题将在 https://github.com/halo-dev/halo/pull/6133 中修复,并发布到 2.17.0,所以移除此提示。

/kind documentation

```release-note
None
```
2024-06-25 02:48:45 +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
3a69e510b3 docs: update default docker registry (#370)
更新部署文档,添加我们的自建 Docker 仓库,并设置为首选。

```release-note
None
```
2024-06-07 07:56:23 +00:00
Ryan Wang
92ef10595e chore: bump pnpm version to 9 (#369) 2024-06-06 16:22:28 +08: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
78416a1337 docs: add documentations for app store plugin (#365)
添加内置应用市场的使用说明,以及更新插件和主题的安装文档。

/kind documentation

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

```release-note
None
```
2024-06-03 02:45:45 +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
Ryan Wang
9420d37857 chore: remove archived docs (#360)
考虑到此仓库的文档版本逐渐变多,会导致编译过慢,所以这个 PR 移除了 2.0-2.9 的历史版本,并将这些版本部署到了 https://v2.archive-docs.halo.run/

<img width="498" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/64281dc1-28c0-4656-a2fc-10ccc050e2a7">

/kind improvement

```release-note
None
```
2024-05-28 11:27:08 +00:00
Ryan Wang
d78a16e217 chore: use swc instead of esbuild (#359)
使用 swc 代替 esbuild,之前在 https://github.com/halo-dev/docs/pull/358 中引入了 esbuild,但发现在生产构建之后会出现这个问题:

<img width="1912" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/5dcd724d-3876-4e58-b902-1818dd9d1fbd">

暂时不清楚为什么,使用 swc 测试构建之后没有这个问题。

/kind bug

```release-note
None
```
2024-05-28 05:18:58 +00:00
Ryan Wang
ac0b158b73 chore: use esbuild instead of babel (#358)
引入 esbuild,提升构建速度。

before:

<img width="777" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/49d28d76-1c10-47c8-ac8c-31b41a31f6bd">

after:

<img width="888" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/61462a4c-ba66-4612-9363-67e5d394601b">


/kind improvement

```release-note
None
```
2024-05-28 03:42:57 +00:00
Ryan Wang
b4e637b4b0 chore: use selfhosted-meilisearch as docs search engine (#357)
使用自建的 Meilisearch 作为文档搜索引擎,代替 Algolia。

/kind improvement

```release-note
None
```
2024-05-28 03:12:58 +00:00
Ryan Wang
23a1936cbb docs: add a description regarding external-url (#356)
在《腾讯云轻量应用模板》文档中添加有关外部访问地址的说明。

/kind documentation

```release-note
None
```
2024-05-20 08:00:42 +00:00
mashirot
f74035fc49 feat: modify ui service startup way (#350)
```release-note
修改 UI 服务启动方式为直接从 pnpm 启动
```
2024-05-17 07:42:37 +00:00
Ryan Wang
c9f55fac58 docs: tencent cloud lighthouse (#354)
添加使用腾讯云轻量应用服务器的应用模板部署的文档。

/kind documentation

```release-note
None
```
2024-05-16 07:12:36 +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
2527d02c6b fix: api version for role template (#351)
### What this PR does?
修复权限控制文档中关于 Role 的 apiVersion 错误的问题

```release-note
None
```
2024-05-13 09:14:30 +00:00
guqing
b8b5a4e34d doc: add doc for template head processor extension point (#348) 2024-05-08 16:10:19 +08:00
Ryan Wang
462340d454 fix: translations (#346) 2024-05-07 23:25:32 +08:00
Ryan Wang
a997fbb948 docs: add tips for metadata name of theme (#347) 2024-05-07 23:25:18 +08:00
Ryan Wang
846d6c3791 docs: update documentation for Halo 2.15 (#345)
为 Halo 2.15.0 更新文档。

/kind documentation

```release-note
None 
```
2024-04-30 08:14:06 +00:00
BugKing
228d058a9d docs: update r2dbc url for MariaDB (#344)
* docs: update r2dbc url for MariaDB

* 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>
2024-04-30 15:42:05 +08:00
Ryan Wang
7e0fbd85be docs: add issues field for theme and plugin manifest example (#342)
为主题和插件的配置文件示例添加 issues 字段。

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

/kind documentation

```release-note
None
```
2024-04-30 04:41:56 +00:00
Nova Kwok
fd7eac2881 Fix typo condtions to conditions (#343)
condtions should be conditions? 🤔
2024-04-26 17:14:54 +00:00
John Niang
2c80278f59 Add documentation for websocket (#341)
See https://github.com/halo-dev/halo/pull/5662#issuecomment-2049166868 for more.

```release-note
None
```
2024-04-25 08:19:14 +00:00
Ryan Wang
0ce0fd13a5 docs: add documentation for user tab (#340)
为用户资料选项卡和个人中心的资料选项卡扩展点添加文档。

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

/kind documentation

```release-note
None
```
2024-04-24 17:25:32 +00:00
Ryan Wang
710c4a480c docs: update example of plugin manifest file (#339)
更新插件开发中的 plugin.yaml 示例。

Ref https://github.com/halo-dev/halo/issues/5721

```release-note
None
```
2024-04-19 01:24:08 +00:00
Ryan Wang
48d2ce43df docs: update example of theme manifest file (#338)
更新主题开发中的 theme.yaml 示例。

Ref https://github.com/halo-dev/halo/issues/5721

```release-note
None
```
2024-04-19 01:22:07 +00:00
Ryan Wang
1bb91bec16 docs: update prepare document (#337)
更新《写在前面》。

- 更新网络要求说明
- 更新 Docker 依赖说明
- 更新 Jar 文件部署说明
- 更新数据库说明
- 更新浏览器支持说明

/kind documentation

```release-note
None
```
2024-04-12 09:06:09 +00:00
Ryan Wang
8cd713b715 chore: update workflow (#335)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2024-04-01 16:07:10 +08:00
Ryan Wang
6e97f3724b docs: update documentation for Halo 2.14 (#334)
为 Halo 2.14.0 更新文档。

/kind documentation

```release-note
None 
```
2024-04-01 07:28:07 +00:00