halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2026-01-13 06:03:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
368 Commits 3 Branches 0 Tags
ccde5aaee35c98a28960a445cbb769cea3f21dc6
Commit Graph

224 Commits

Author SHA1 Message Date
困困鱼
1add3ef3dd docs: refine docs for postFinder.listByOwner (#391) 
补充根据创建者用户名和分页参数获取文章列表。

```release-note
None
```
 2024-08-09 13:06:40 +00:00
Ryan Wang
8ee81e718b chore: update afdian url (#392) 
/kind cleanup

更新爱发电的地址。

```release-note
None
```
 2024-08-05 03:52:25 +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
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
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
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
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
23a1936cbb docs: add a description regarding external-url (#356) 
在《腾讯云轻量应用模板》文档中添加有关外部访问地址的说明。

/kind documentation

```release-note
None
```
 2024-05-20 08:00:42 +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
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
Nova Kwok
fd7eac2881 Fix typo condtions to conditions (#343) 
condtions should be conditions? 🤔
 2024-04-26 17:14:54 +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
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
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
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
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
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
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
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
Anye
a63d555d7b Add notification settings to user guide (#292) 
```release-note
None
```
 2023-12-10 14:26:09 +00:00