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
```
11 months ago
c842f1341e
docs: 更新FAQ中的忘记密码处理方式 ( #301 )
...
Close #282
```release-note
None
```
11 months ago
a63d555d7b
Add notification settings to user guide ( #292 )
...
```release-note
None
```
12 months ago
8759dafa82
docs: add documentation for user center ( #290 )
...
提供个人中心的文档。
/kind documentation
Fixes #285
```release-note
None
```
12 months ago
a7707ee2ca
docs: add documentation for setup page ( #289 )
...
添加系统初始化的文档。
/kind documentation
Fixes #286
```release-note
None
```
12 months ago
9110357574
docs: add documentation for theme error template ( #287 )
...
添加主题错误模板的文档。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/144
```release-note
None
```
12 months ago
8114326771
docs: refine documentation for repeater formkit input ( #288 )
...
更新 FormKit Repeater 的文档。
/kind documentation
```release-note
None
```
12 months ago
11a4d97602
docs: update documentation for development ( #284 )
...
更新开发环境运行文档，补充关于 UC 个人中心的描述。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/278
```release-note
None
```
12 months ago
df6ed25a8e
docs: refine documentation of halo:comment tag ( #281 )
...
从 Halo 2.9 开始，判断评论组件是否显示的条件不再只是单纯的判断评论插件是否安装。
see https://github.com/halo-dev/halo/pull/4271
/kind documentation
```release-note
None
```
1 year ago
7e8a8ecb0d
docs: update documentation for Halo 2.11 ( #283 )
...
为 Halo 2.11.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
78ab4dbe14
docs: refine h2 database tips ( #280 )
...
优化使用 H2 数据库的提示。
/kind documentation
```release-note
None
```
1 year ago
d61ada31bc
fix: description of container commands ( #279 )
...
修复关于容器参数的描述，从 2.1 之后不应该是**环境变量**
/kind documentation
```release-note
None
```
1 year ago
eb1b150785
docs: add downloadPluginPresets step for development documentation ( #277 )
...
为开发环境运行文档添加下载预设插件的步骤。
/kind documentation
```release-note
None
```
1 year ago
d80d49e1ac
docs: remove oneinstack related documentations ( #275 )
...
移除 OneinStack 相关文档，目前 OneinStack 已经完全无法使用。
https://oneinstack.com/
```release-note
None
```
1 year ago
42206e7b15
docs: improve backup instructions in upgrade documentations ( #274 )
...
优化版本升级的备份说明，统一改为使用系统提供的备份功能，而不是手动操作工作目录。
```release-note
None
```
1 year ago
78a0e1b3f1
docs: improve build step in plugin document ( #273 )
...
构建指令不全 https://github.com/halo-dev/plugin-starter 这个链接中的readme指令是全的，有pnpmInstall这个步骤
/kind documentation
```release-note
None
```
1 year ago
2a38801e80
docs: improve documentations ( #272 )
...
优化halo文档（开发者指南->系统开发->构建）
/kind documentation
```release-note
None
```
1 year ago
147952f9c2
docs: improve documentations of plugin development ( #271 )
...
优化 Halo 插件开发文档。
/kind documentation
```release-note
None
```
1 year ago
6446098581
fix: broken links ( #266 )
...
修复所有文档的错误链接。
/kind documentation
```release-note
None
```
1 year ago
871c231a7c
docs: add sponsor page ( #265 )
...
添加赞助页面。
/kind documentation
```release-note
None
```
1 year ago
0abd6612d8
docs: add security notice for oneinstack ( #261 )
...
添加关于 OneinStack 的安全性提示。
/kind documentation
```release-note
None
```
1 year ago
ba0c62ef6b
docs: update documentation for Halo 2.10 ( #262 )
...
为 Halo 2.10.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
587cd952d6
docs: add halo on podman ( #256 )
...
添加使用 Podman 部署Halo的方法.
```release-note
None
```
1 year ago
8df9f0ceeb
fix: example code in menu finder api ( #260 )
...
Fixes https://github.com/halo-dev/docs/issues/259
```release-note
修正文档中关于获取菜单显示名称的代码示例，详情请参见：https://github.com/halo-dev/docs/issues/259
```
1 year ago
58b41335e1
docs: lock postgres version in docker compose example ( #257 )
...
固定 Docker Compose 文档中 postgres 的版本，防止使用 latest 标签导致跨版本不兼容。
/kind documentation
```release-note
None
```
1 year ago
4a59d44091
fix: typos in plugin docs ( #254 )
1 year ago
2e77363d29
fix: menu api example in theme dev docs ( #252 )
...
日常主题开发中，我们应该使用菜单最终生成到名字
```release-note
None
````
1 year ago
f1b641dc12
docs: update documentation for Halo 2.9 ( #246 )
...
为 Halo 2.9.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
d937472224
docs: add downloadPluginPresets step for build documentation ( #243 )
...
完善开发环境构建的文章，添加下载预设插件的步骤。
Fixes #242
Ref https://github.com/halo-dev/halo/issues/4418#issuecomment-1677354115
/kind documentation
```release-note
None
```
1 year ago
72c2ef8cc7
docs: update documentation for Halo 2.8 ( #238 )
...
为 Halo 2.8.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
18bab50498
docs: update documentation for Halo 2.7 ( #234 )
...
为 Halo 2.7.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
801291838f
docs: 增加 Helm 部署文档 ( #233 )
...
增加 Helm Chart 部署文档。
Close #181
1 year ago
2acc48e6f9
docs: fix headings of nginxproxymanager.md ( #230 )
1 year ago
3119754ff6
docs: fix broken link in backup-migration.md ( #231 )
1 year ago
fb691cad4a
docs: refine repeater props ( #232 )
...
完善开发者文档中关于 Repeater 表单项的参数。
/kind documentation
```release-note
None
```
1 year ago
2222905387
docs: improve documentation of 1Panel ( #229 )
...
优化使用 1Panel 部署的文档。
/kind documentation
```release-note
None
```
1 year ago
3ef8b4c0f9
docs: refactor documentations of user guide ( #225 )
...
重构用户指南的部分内容。
/kind documentation
```release-note
None
```
1 year ago
b3382b0170
docs: fix typos and word case ( #226 )
...
修正部分单词错误和写法错误。
/kind improvement
```release-note
None
```
2 years ago
81cdc88b31
docs: update form schema link ( #224 )
...
Fix #223
```release-note
None
```
2 years ago
5d74edea8f
docs: update documentation for Halo 2.6 ( #222 )
...
为 Halo 2.6 更新文档。
/kind documentation
```release-note
None
```
2 years ago
4b934c0ace
docs: add configuration examples for the Windows platform in the plugin-related documents ( #219 )
...
Halo 插件开发 Windows 环境下插件绝对路径的补充
Ref #218
/kind documentation
```release-note
None
```
2 years ago
11b2ac3b3e
docs: update documentation of attachment form schema ( #217 )
...
更新 Form Schema 文档中 Attachment 类型的参数。
Ref https://github.com/halo-dev/halo/pull/3827
/kind documentation
```release-note
None
```
2 years ago
e7cce8f366
docs: fix incorrect configuration instructions in runtime-mode.md ( #221 )
...
/kind documentation
Closes #220
```release-note
None
```
2 years ago
9daf914879
docs: refine documentation of installation ( #215 )
...
优化安装文档。
1. 优化安装完成之后的提示。
2. 优化 Docker 启动参数的描述。
3. Docker 的数据库配置参数添加 MariaDB 的说明。
4. 移动反向代理方式的顺序。
/kind documentation
```release-note
None
```
2 years ago
bc5fe02283
docs: docs: update documentation for Halo 2.5 ( #212 )
...
为 Halo 2.5 更新文档。
/kind documentation
```release-note
None
```
2 years ago
38b006eea3
docs: update migration documentation ( #209 )
...
更新迁移文档。目前 Halo 的官方迁移插件已经基本实现所有数据的迁移，请看：
- https://github.com/halo-sigs/plugin-migrate/pull/19
- https://github.com/halo-sigs/plugin-migrate/pull/21
Fixes #208
/kind documentation
```release-note
None
```
2 years ago
fe704e8036
Add installation method while MySQL exists ( #201 )
...
Add docker-compose to use the existing Mysql deployment method
```release-note
None
```
2 years ago
862756a76c
docs: update documentation for Halo 2.4.1 ( #207 )
...
为 Halo 2.4.1 更新文档。
/kind documentation
```release-note
None
```
2 years ago
c2bac256e9
Update document about building halo 2.4.0 ( #206 )
...
See https://github.com/halo-dev/docs/issues/205 for more.
```release-note
None
```
2 years ago
4edbf7e639
docs: update documentation for Halo 2.4 ( #203 )
...
为 Halo 2.4 更新文档。
/kind documentation
```release-note
None
```
2 years ago
96feaf5631
typo: fix typo in the description of external url ( #202 )
...
修正 Docker 参数 `halo.external-url` 描述中的错别字。
/kind documentation
```release-note
None
```
2 years ago
aaa258d244
docs: add docs for installation with 1Panel ( #200 )
...
增加使用 1Panel 进行部署的文档。
Fixes #199
```release-note
None
```
2 years ago
1d939e714f
docs: add target attribute documentation for menu item ( #191 )
...
添加主题开发 - 导航菜单中关于 `target` 属性的文档
/kind documentation
Fixes #190
```release-note
None
```
2 years ago
a23ea5940f
docs: update documentation for Halo 2.3 ( #196 )
...
为 Halo 2.3 更新文档。
/kind documentation
```release-note
None
```
2 years ago
29a7cc4f78
fix: incorrect hightlight number of docker compose example code block ( #195 )
...
/kind documentation
修复由 https://github.com/halo-dev/docs/pull/189 导致的 Docker Compose 代码块高亮行错误的问题。
before:
<img width="727" alt="image" src="https://user-images.githubusercontent.com/21301288/221819214-fd261a4a-c6bf-4228-8377-bbb3a7aebb55.png ">
after:
<img width="917" alt="image" src="https://user-images.githubusercontent.com/21301288/221819329-5087b143-e93c-4eff-a101-2d003c8f2e2a.png ">
```release-note
None
```
2 years ago
b0e841bc4a
Refine docker run command ( #194 )
...
```release-note
None
```
2 years ago
4fdea96f09
docs: add a tip for default admin username and password for development environment ( #192 )
...
添加开发环境下初始管理员用户名和密码的提示
/kind documentation
Fixes #188
```release-note
None
```
2 years ago
f6e0ae6f1d
docs: add healthcheck for halo in compose ( #189 )
...
在 Docker Compose 文件中，使用 `/actuator/health/readiness` 接口为 Halo 服务增加健康检查。
```release-note
docs: add healthcheck for halo in compose
```
2 years ago
f21171de21
feat: add plugin development docs ( #123 )
...
### What this PR does?
添加插件开发文档
### Which issue(s) this PR fixes
Fixes #113
/area docs
```release-note
None
```
2 years ago
4d59c627c5
fix: nginx link error in docker-compose page ( #186 )
...
```release-note
None
```
2 years ago
a324a86fc3
docs: add documentation of traefik proxy ( #172 )
...
增加 Traefik 与 Halo 配合使用的文档
/kind documentation
```release-note
None
```
2 years ago
e89334a6b4
docs: add documentation for custom template tag ( #179 )
...
添加 Halo 为 Thymeleaf 提供的 Halo 专有标签的文档。
/kind documentation
Fixes #160
```release-note
None
```
2 years ago
6f8b67c9f0
docs: add documentation for template engine global variables ( #180 )
...
添加 Halo 为模板引擎提供的全局变量的文档。
/kind documentation
Fixes #161
```release-note
None
```
2 years ago
b8a50b78b6
docs: remove version tips ( #183 )
...
Fixes #182
/kind documentation
```release-note
None
```
2 years ago
bf412ac04e
docs: add documentation for update docker image to upgrade halo ( #177 )
...
添加更新 Docker 镜像的文档。
/kind documentation
Fixes #150
```release-note
None
```
2 years ago
d13c86a5a7
docs: add documentation for author template variables ( #176 )
...
添加主题端作者归档页面的文档。后端改动可查阅：https://github.com/halo-dev/docs/issues/144
/kind documentation
Fixes #143
```release-note
None
```
2 years ago
922502a9d3
docs: add tips of console proxy ( #178 )
...
在开发环境文档中添加 Console 代理的提示。
/kind documentation
```release-note
None
```
2 years ago
d623ac063a
docs: add lastModifyTime field description for post and singlePage related vo ( #175 )
...
为主题开发文档中关于文章和自定义页面的 VO 描述添加 lastModifyTime 字段。后端改动见：https://github.com/halo-dev/halo/pull/3101
/kind documentation
Fixes #169
```release-note
None
```
2 years ago
55e5f60aee
docs: update documentation for Halo 2.2 ( #174 )
...
为 Halo 2.2 更新文档。
/kind documentation
```release-note
None
```
2 years ago
96ca3e2c50
docs: update documentation for migrate from Halo 1.x ( #171 )
...
Halo 1.5 / 1.6 的迁移插件已经更新：https://github.com/halo-sigs/plugin-migrate/releases/tag/v1.1.0
同步修改使用文档。
Fixes https://github.com/halo-dev/docs/issues/170
/kind documentation
```release-note
None
```
2 years ago
91683d445a
docs: bump mysql version to 8.0.31 for docker documentation ( #167 )
...
将 Docker Compose 文档中的 MySQL 版本升级到 8.0.31 以支持 Arm 架构的机器。
/kind documentation
Fixes #135
```release-note
None
```
2 years ago
8c3d6d097e
fix: wrong example of contributor finder api ( #166 )
...
修复关于 Contributor 的 Finder API 示例错误的问题。
/kind documentation
Fixes #158
```release-note
None
```
2 years ago
1165cff265
docs: add documentation for annotations form definition ( #165 )
...
添加 Annotations Form 表单定义和使用的文档。
Fixes #154
/kind documentation
```release-note
None
```
2 years ago
4634f74021
Refine run methods with arguments instead of environments ( #164 )
...
#### What this PR does/Why we need it?
1. Refine Docker run command and Docker compose file with arguments instead of environments for Halo 2.1 and 2.2.0-SNAPSHOT.
2. Change environments description into arguments description.
#### Which issue(s) this PR fixes:
Fix https://github.com/halo-dev/docs/issues/163
```release-note
None
```
2 years ago
ef03b0fbfb
docs: update documentation for Halo 2.1 ( #162 )
...
为 Halo 2.1 更新文档。
see https://github.com/halo-dev/halo/releases/tag/v2.1.0
/kind documentation
```release-note
None
```
2 years ago
c1bc43a686
docs: remove the "Internal members can access" option from the post's usage documentation ( #155 )
...
halo2.0目前从issue得知，并未实现“内部成员可访问”可见性控制，和文档docs不同步
```release-note
None
```
2 years ago
1416be911c
docs: add documentation for use with Nginx Proxy Manager ( #149 )
...
添加nginxproxymanager的文档，之前PR关闭了
```release-note
None
```
2 years ago
2ec6fbb8af
Fix illustration for uninstalling plugins ( #152 )
...
```release-note
fix: 卸载插件配图错误
````
Fixes #151
2 years ago
f11892ec27
docs: update documentation for Halo 2.0.2 ( #148 )
...
为 [Halo 2.0.2](https://github.com/halo-dev/halo/releases/tag/v2.0.2 ) 更新版本号。
/kind documentation
```release-note
None
```
2 years ago
6bcbab1855
docs: update documentation for pull request contribution ( #147 )
...
更新 Pull Request 贡献指南。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/146
```release-note
None
```
2 years ago
dcb7a89b82
docs: add description of the docker environment variable ( #137 )
...
为部署文档提供 Docker 环境变量的解释。
/kind documentation
```release-note
None
```
2 years ago
039159dfc0
docs: add password resetting section in FAQ ( #145 )
...
```release-note
docs: add password resetting section in FAQ
```
在 FAQ 中增加忘记密码处理相关内容。
2 years ago
ec3cba41cf
docs: add documentation about compilation ( #138 )
...
提供自编译可执行 JAR 和 Docker 镜像的文档。
Fixes https://github.com/halo-dev/docs/issues/114
/kind documentation
```release-note
None
```
2 years ago
39d34fbea6
docs: improve the developer run guide ( #139 )
...
针对 WIndows 平台优化开发者运行的文档。
/kind documentation
```release-note
None
```
2 years ago
1d43c93f49
feat: improve the quick start section of the introduction ( #136 )
...
更新介绍文档中快速开始的命令，提供初始管理员账号和外部访问链接的环境变量设置。
/kind documentation
```release-note
None
```
2 years ago
749083c815
docs: remove third-party document ( #134 )
...
移除三方安装指南，目前已经不适用于 Halo 2.0
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/131
```release-note
None
```
2 years ago
36a4db6796
docs: refine the field descriptions of the theme VO ( #133 )
...
完善主题开发文档关于 VO 字段的描述。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/122
```release-note
None
```
2 years ago
2ed9998d8a
docs: update documentation for Halo 2.0.1 ( #132 )
...
为 [Halo 2.0.1](https://github.com/halo-dev/halo/releases/tag/v2.0.1 ) 更新版本号。
/kind documentation
```release-note
None
```
2 years ago
e57d33d369
docs: update tips for migration ( #130 )
...
在迁移文档增加站点需要 HTTPS 的提示。
/kind documentation
```release-note
None
```
2 years ago
fdad517e54
docs: add docker installation tips ( #129 )
...
在部署文档中添加安装 Docker 的提示。
/kind documentation
```release-note
None
```
2 years ago
5c76928800
chore: set 2.0 is latest version ( #127 )
...
将 2.0 版本的文档设置为最新的文档。同时保留 /2.0.0-SNAPSHOT/
/kind documentation
```release-note
None
```
2 years ago
987a9c9d3f
Change mirror frontend URL from https://dl.halo.run to https://download.halo.run ( #108 )
...
Change mirror site frontend website to new address, shouldn't affect old download link such as `https://dl.halo.run/release/halo-1.3.0.jar `
Related post: https://nova.moe/halo-mirror-serverless/
Related repo: https://github.com/halo-sigs/halo-dl-api
```release-note
None
```
2 years ago
be858399ad
docs: update versions for `1.6.0` `1.5.5` `2.0.0-alpha.2` ( #100 )
...
更新 Halo `1.6.0` `1.5.5` `2.0.0-alpha.2` 的版本号。
/kind documentation
/cc @halo-dev/sig-docs
```release-note
None
```
2 years ago
4921736046
refactor: document versioning structure ( #99 )
...
重构文档版本结构。
- 移除 1.5/1.4 相关所有 patch 版本的文档，使用 1.5/1.4 版本号代替。
- 创建 1.6 的文档版本。
- 后续针对 1.5 或者 1.6 的更新，可以直接对具体版本进行更改。
本打算使用 [@docusaurus/plugin-client-redirects](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-client-redirects ) 做已删除的 patch 版本的重定向，旦可能不是很好满足匹配重定向的需求。~~所以在此 PR 合并之前我将通过 Nginx 对具体版本进行重定向转发~~。
比如：`/1.4.17/{path}` 重定向到 `/1.4/{path}`，`/1.5.4/{path}` `/1.5.3/{path}` 都从定向到 `/1.5/{path}`
/kind documentation
/cc @halo-dev/sig-docs
> PS: 此 PR 未对新发布的 [1.6.0](https://github.com/halo-dev/halo/releases/tag/v1.6.0 ) [1.5.5](https://github.com/halo-dev/halo/releases/tag/v1.5.5 ) [2.0.0-alpha.2](https://github.com/halo-dev/halo/releases/tag/v2.0.0-alpha.2 ) 做修改，将在后续 PR 更改。
```release-note
None
```
2 years ago
99a14110b9
docs: provides Halo 2.0 online demo environment ( #98 )
...
提供 Halo 2.0 的在线演示环境。
/kind documentation
```release-note
None
```
2 years ago
7c5457c36f
Update third-party.md ( #93 )
...
在极空间nas中使用docker搭建halo
2 years ago
f630eaeca6
docs: add a tip that cannot map halo to a domain subfolder ( #90 )
...
添加不能将 Halo 反向代理到域名子目录的提示。
/kind documentation
```release-note
None
```
2 years ago
322ebdba54
fix: typo in backup-migration.md ( #87 )
...
```release-note
None
```
2 years ago
Kent Liao
bf0e4ee4f0
fix: linkTag example ( #86 )
...
methods:
* listTeams
* listTeamsByRandom
```release-note
None
```
2 years ago
e855ddac26
fix: photoTag listByTeam example ( #84 )
...
Fixes #85
```release-note
None
```
2 years ago
Ryan Wang
BugKing
Anye
shangjianan2
John
AllinProgram
TnZzZHlp
Hilary Liu
airbo
Simple
wxyShine
John Niang
Li
舒夏
guqing
WinteWu
Scott_N_Yang
Alanrah
RalstonLiu
Nova Kwok
603466551
YYplus
Kent Liao
vayci
