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
Nova Kwok
fd7eac2881
Fix typo condtions to conditions ( #343 )
...
condtions should be conditions? 🤔
7 months ago
John Niang
2c80278f59
Add documentation for websocket ( #341 )
...
See https://github.com/halo-dev/halo/pull/5662#issuecomment-2049166868 for more.
```release-note
None
```
7 months ago
Ryan Wang
0ce0fd13a5
docs: add documentation for user tab ( #340 )
...
为用户资料选项卡和个人中心的资料选项卡扩展点添加文档。
Ref https://github.com/halo-dev/halo/pull/5763
/kind documentation
```release-note
None
```
7 months ago
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
```
7 months ago
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
```
7 months ago
Ryan Wang
1bb91bec16
docs: update prepare document ( #337 )
...
更新《写在前面》。
- 更新网络要求说明
- 更新 Docker 依赖说明
- 更新 Jar 文件部署说明
- 更新数据库说明
- 更新浏览器支持说明
/kind documentation
```release-note
None
```
8 months ago
Ryan Wang
8cd713b715
chore: update workflow ( #335 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
8 months ago
Ryan Wang
6e97f3724b
docs: update documentation for Halo 2.14 ( #334 )
...
为 Halo 2.14.0 更新文档。
/kind documentation
```release-note
None
```
8 months ago
ね律こ
f4fdff1317
docs: delete unnecessary options ( #333 )
...
#### What type of PR is this?
/kind documentation
#### What this PR does / why we need it:
同时使用 `-it` 和 `-d`,`-d` 会覆盖 `-it`,容器将会在后台运行,而 `-it` 参数请求的交互式会话和伪终端不会生效。
#### Does this PR introduce a user-facing change?
```release-note
None
```
8 months ago
Takagi
ce581bcc6d
docs: add the selection attribute to handleDrop ( #332 )
...
将 selection 属性添加至默认编辑器的 handleDrop 扩展中。相关改动查看 https://github.com/halo-dev/halo/pull/5570
/kind documentation
```release-note
None
```
8 months ago
Takagi
64b30fae7d
docs: add formkit verfiyForm documentation ( #327 )
...
为 FormKit Schema 文档添加 verifyForm 的内容。相关改动查看 https://github.com/halo-dev/halo/pull/5464
/kind documentation
```release-note
None
```
8 months ago
Ryan Wang
3922a171a1
docs: add title prop for editor create extension point ( #325 )
...
为编辑器扩展添加 title 字段的描述,为 https://github.com/halo-dev/halo/pull/5465 的改动添加文档。
/kind documentation
```release-note
None
```
8 months ago
Ryan Wang
d578915c59
docs: update sample of docker compose file ( #324 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
8 months ago
MashiroT
47d0964151
addressing outdated version issue of Checkstyle in code style documentation ( #330 )
...
#329
/kind documentation
```
None
```
8 months ago
guqing
f8177d84a2
doc: refine doc for route rules of custom extension apis ( #322 )
...
### What this PR does?
优化关于自定义 APIs 路由规则的描述文档
```release-note
None
```
8 months ago
Ryan Wang
7dd663136d
docs: update documentation for Halo 2.13 ( #321 )
...
为 Halo 2.13.0 更新文档。
/kind documentation
```release-note
None
```
9 months ago
John Niang
08ebdfc95f
Add documentation for authentication webfilter extension points ( #320 )
...
* Add documentation for authentication webfilter extension points
* Refine requirements of extension point definition
9 months ago
Ryan Wang
276bbb729a
docs: refine documentation for annotation setting name ( #314 )
...
修改《元数据表单定义》文档中关于 metadata.name 的描述。
Fixes https://github.com/halo-dev/docs/issues/298
/kind documentation
```release-note
None
```
9 months ago