John Niang
fcdda6845e
Rectify the invalid external URL ( #399 )
...
Fixes #397
```release-note
修复错误格式的 External URL 配置
```
3 months ago
Ryan Wang
0dcd978195
docs: improve the display of docker-compose examples ( #396 )
...
优化 Docker Compose 部署文档的篇幅,使用选项卡展示不同的配置示例。
<img width="1030" alt="image" src="https://github.com/user-attachments/assets/47bce5f8-4e01-4a32-b78a-38dc8d35b6ff ">
/kind documentation
```release-note
None
```
3 months ago
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
```
4 months ago
困困鱼
4a53db88f4
docs: make comment and reply list item operations extendable ( #393 )
...
```release-note
None
```
4 months ago
困困鱼
1add3ef3dd
docs: refine docs for postFinder.listByOwner ( #391 )
...
补充根据创建者用户名和分页参数获取文章列表。
```release-note
None
```
4 months ago
Ryan Wang
8ee81e718b
chore: update afdian url ( #392 )
...
/kind cleanup
更新爱发电的地址。
```release-note
None
```
4 months ago
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
```
4 months ago
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
```
4 months ago
BugKing
64d482f224
docs: update tencent-cloud-lighthouse.md ( #387 )
...
```release-note
None
```
4 months ago
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
```
5 months ago
BugKing
bf152a8458
docs: 增加离线部署文档 ( #386 )
5 months ago
Ryan Wang
1714c0f496
docs: add documentations for plugin detail modal component ( #385 )
...
添加 2.17.0 添加的 PluginDetailModal 组件的文档。
/kind documentation
```release-note
None
```
5 months ago
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
```
5 months ago
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
```
5 months ago
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
```
5 months ago
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
```
5 months ago
guqing
59096a9e4b
chore: remove deprecated plugin wrapper ( #379 )
...
### What this PR does?
移除已经过时的 PluginWrapper 引用
```release-note
None
```
5 months ago
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
```
5 months ago
Ryan Wang
d61ebe4f62
docs: add api client usage docs for plugin ( #374 )
...
为插件提供 api-client 的使用文档。
/kind documentation
```release-note
None
```
5 months ago
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
```
5 months ago
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
```
5 months ago
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
```
5 months ago
Takagi
976fcd9576
docs: add dynamic list doc ( #373 )
...
增加 formkit list 的文档。
/kind documentation
```release-note
None
```
5 months ago
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
```
5 months ago
Ryan Wang
9c89e60116
docs: update pnpm version require ( #371 )
...
/kind documentation
```release-note
None
```
5 months ago
Ryan Wang
3a69e510b3
docs: update default docker registry ( #370 )
...
更新部署文档,添加我们的自建 Docker 仓库,并设置为首选。
```release-note
None
```
6 months ago
Ryan Wang
92ef10595e
chore: bump pnpm version to 9 ( #369 )
6 months ago
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
```
6 months ago
Ryan Wang
7eec30763e
docs: update documentation for Halo 2.16 ( #367 )
...
为 Halo 2.16.0 更新文档。
/kind documentation
```release-note
None
```
6 months ago
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
```
6 months ago
Ryan Wang
07e7417c83
fix: broken links ( #366 )
...
修复异常链接。
```release-note
None
```
6 months ago
Ryan Wang
8846344ca8
typo: 登陆 -> 登录 ( #364 )
...
更新文案:登陆 -> 登录
/kind documentation
```release-note
None
```
6 months ago
BugKing
18b4ee061f
fix: total pages in archives.html sample ( #363 )
...
```release-note
None
```
6 months ago
apanonar
f995b1a5ae
docs: update document of plugin example ( #361 )
...
修改插件开发案例文档,来匹配最新的 [plugin-starter](https://github.com/halo-dev/plugin-starter )。
```release-note
None
```
6 months ago
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
```
6 months ago
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
```
6 months ago
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
```
6 months ago
Ryan Wang
b4e637b4b0
chore: use selfhosted-meilisearch as docs search engine ( #357 )
...
使用自建的 Meilisearch 作为文档搜索引擎,代替 Algolia。
/kind improvement
```release-note
None
```
6 months ago
Ryan Wang
23a1936cbb
docs: add a description regarding external-url ( #356 )
...
在《腾讯云轻量应用模板》文档中添加有关外部访问地址的说明。
/kind documentation
```release-note
None
```
6 months ago
mashirot
f74035fc49
feat: modify ui service startup way ( #350 )
...
```release-note
修改 UI 服务启动方式为直接从 pnpm 启动
```
6 months ago
Ryan Wang
c9f55fac58
docs: tencent cloud lighthouse ( #354 )
...
添加使用腾讯云轻量应用服务器的应用模板部署的文档。
/kind documentation
```release-note
None
```
6 months ago
guqing
8df5dcf9e9
refactor: role template docs ( #353 )
...
### What this PR does?
重写 API 权限控制的文档以减小用户理解成本
```release-note
None
```
6 months ago
Ryan Wang
fc626d152c
docs: remove colorScheme param for halo:comment tag ( #352 )
...
移除文档中关于 `halo:comment` 标签的 colorScheme 字段,这是以前的设计错误,此模板引擎标签不应该涉及最终 UI 相关的功能。目前官方的评论插件已经支持通过 CSS 变量来改变配色和其他样式。
/kind documentation
```release-note
None
```
6 months ago
guqing
2527d02c6b
fix: api version for role template ( #351 )
...
### What this PR does?
修复权限控制文档中关于 Role 的 apiVersion 错误的问题
```release-note
None
```
6 months ago
guqing
b8b5a4e34d
doc: add doc for template head processor extension point ( #348 )
7 months ago
Ryan Wang
462340d454
fix: translations ( #346 )
7 months ago
Ryan Wang
a997fbb948
docs: add tips for metadata name of theme ( #347 )
7 months ago
Ryan Wang
846d6c3791
docs: update documentation for Halo 2.15 ( #345 )
...
为 Halo 2.15.0 更新文档。
/kind documentation
```release-note
None
```
7 months ago
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>
7 months ago
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
```
7 months ago