Commit Graph

282 Commits

Author SHA1 Message Date
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
ね律こ
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
```
2024-03-27 09:56:07 +00:00
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
```
2024-03-27 04:24:08 +00:00
Takagi
64b30fae7d docs: add formkit verfiyForm documentation (#327)
为 FormKit Schema 文档添加 verifyForm 的内容。相关改动查看 https://github.com/halo-dev/halo/pull/5464

/kind documentation

```release-note
None
```
2024-03-27 03:26:07 +00:00
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
```
2024-03-27 03:22:06 +00:00
Ryan Wang
d578915c59 docs: update sample of docker compose file (#324)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2024-03-20 15:49:01 +08:00
MashiroT
47d0964151 addressing outdated version issue of Checkstyle in code style documentation (#330)
#329 
/kind documentation
```
None
```
2024-03-19 09:14:07 +00:00
guqing
f8177d84a2 doc: refine doc for route rules of custom extension apis (#322)
### What this PR does?
优化关于自定义 APIs 路由规则的描述文档

```release-note
None
```
2024-03-14 02:32:24 +00:00
Ryan Wang
7dd663136d docs: update documentation for Halo 2.13 (#321)
为 Halo 2.13.0 更新文档。

/kind documentation

```release-note
None 
```
2024-03-01 04:35:02 +00:00
John Niang
08ebdfc95f Add documentation for authentication webfilter extension points (#320)
* Add documentation for authentication webfilter extension points

* Refine requirements of extension point definition
2024-03-01 11:11:18 +08:00
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
```
2024-02-29 09:41:38 +00:00
Ryan Wang
1b33ca6668 docs: remove theme-astro-starter template (#315)
目前 https://github.com/halo-sigs/theme-astro-starter 还处于验证阶段,放置在文档中可能会造成一定困惑。

/kind documentation

```release-note
None
```
2024-02-20 08:40:08 +00:00
John Niang
54c9c8e816 Correct systemd syntax by removing double quotes (#312)
This PR removes double quotes in `ExecStart` and changes `spring.config.location` argument into `spring.config.additional-location`.

See https://github.com/halo-dev/halo/issues/5259#issuecomment-1931481647 and 9166ebe510 (r138357255) for more.

```release-note
None
```
2024-02-08 08:26:08 +00:00
John Niang
2f2e1a6f1a Refactor project build and run (#308)
This PR mainly adapts PR <https://github.com/halo-dev/halo/pull/5314>.

```release-note
None
```
2024-02-06 06:32:13 +00:00
Ryan Wang
da096deb01 docs: remove unnecessary tips (#311)
https://github.com/halo-dev/docs/pull/309 中,修改配置挂载方式之后没有删除以前的提示。

/kind documentation

```release-note
None
```
2024-02-06 06:26:13 +00:00
Ryan Wang
9166ebe510 fix: missing config location attribute in jar document (#309)
修改 Jar 文件部署文档,补充配置文件位置的参数说明。

/kind documentation

Ref https://github.com/halo-dev/halo/issues/5259#issuecomment-1925783729

```release-note
None
```
2024-02-06 04:06:13 +00:00
Ryan Wang
97e0b2b526 refactor: documentation structure (#310)
重构文档结构,将开发者文档与使用文档分开。

<img width="641" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/baed360c-997b-443c-9a8e-cc53e268b8f4">
<img width="766" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/08326aab-d474-4075-bdc9-c628a39ba715">


Note: 此改动不造成死链。

```release-note
None
```
2024-02-05 10:00:13 +00:00
Ryan Wang
d0ea59e6e2 docs: update documentation for Halo 2.12 (#306)
为 Halo 2.12.0 更新文档。

/kind documentation

```release-note
None 
```
2024-02-01 03:11:39 +00:00
Ryan Wang
2ebc8ca714 docs: add documentation for deployment using a jar file (#305)
添加使用 Jar 文件部署的文档。

/kind documentation

```release-note
None
```
2024-02-01 02:55:39 +00:00
Ryan Wang
6a253dd896 docs: refactor documentation of plugin development (#291)
重构和完善插件开发文档。

/kind documentation

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

```release-note
None
```

---------

Signed-off-by: Ryan Wang <i@ryanc.cc>
Co-authored-by: guqing <i@guqing.email>
2024-01-30 16:00:18 +08:00
Ryan Wang
5e15e35b29 fix: broken links (#302)
修复引用的 https://www.halo.run/archives/halo-and-webp 链接地址。

/kind documentation

```release-note
None
```
2024-01-02 02:50:12 +00:00
Ryan Wang
1d97214ad3 chore: remove 1.x documentation (#303)
移除 1.x 的文档,以及清除一些过时文档。

1.x 所有文档已经被移动到 https://github.com/halo-dev/v1-legacy-docs 并托管在 https://v1.legacy-docs.halo.run

<img width="669" alt="图片" src="https://github.com/halo-dev/docs/assets/21301288/684e4b0e-fc60-44ae-bda1-52fe62c4670d">

/kind cleanup

```release-note
None
```
2024-01-02 02:38:12 +00:00
BugKing
c842f1341e docs: 更新FAQ中的忘记密码处理方式 (#301)
Close #282

```release-note
None
```
2023-12-26 03:26:06 +00:00