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
3f900d0826
fix: docker-compose documentation about the mysql container configurations ( #83 )
...
Fixes halo-dev/halo#2257
see https://hub.docker.com/_/mysql
/kind documentation
```release-note
None
```
Signed-off-by: Ryan Wang <i@ryanc.cc>
2 years ago
331c29b3af
release: create 1.5.4 version ( #82 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
2 years ago
eba654da79
release: create 1.5.3 version ( #79 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
e37e4e4a12
Refine pr.md to be clearer ( #77 )
...
* Refine contribution.md to be clearer
Signed-off-by: johnniang <johnniang@fastmail.com>
* Update pr.md in version-1.5.2 folder as well
Signed-off-by: johnniang <johnniang@fastmail.com>
3 years ago
a77813a3ac
docs: improve docker compose documentations ( #74 )
...
* docs: improve docker-compose documentations
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: improve docker-compose documentations
Signed-off-by: Ryan Wang <i@ryanc.cc>
* fix: redis network typo
Signed-off-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: John Niang <johnniang@fastmail.com>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: John Niang <johnniang@fastmail.com>
* Update versioned_docs/version-1.5.2/getting-started/install/other/docker-compose.md
Co-authored-by: John Niang <johnniang@fastmail.com>
* fix: halo_redis not in depends_on
Signed-off-by: Ryan Wang <i@ryanc.cc>
* fix: Docker-Compose -> Docker Compose
Signed-off-by: Ryan Wang <i@ryanc.cc>
* perf: add indentation to list block level content
Signed-off-by: Ryan Wang <i@ryanc.cc>
* perf: add indentation to list block level content
Signed-off-by: Ryan Wang <i@ryanc.cc>
Co-authored-by: John Niang <johnniang@fastmail.com>
3 years ago
f42f651081
chore: remove archived documentations ( #72 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
d605271fcc
docs: update markdown.md for Halo 1.5.x ( #70 )
...
* doc: update markdown document
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: update markdown.md
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: update markdown.md
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: update markdown.md
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
ddcfbeed36
release: create 1.5.2 version ( #69 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
dcf872a0dc
docs: fix cases ( #66 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
9c9185e681
release: create 1.5.1 version ( #63 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
00f21dbb78
docs: steps to add clear leveldb cache to upgrade documentation ( #59 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
163e387b9c
doc: update intro.md ( #55 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
75405a306d
release: create 1.5.0 version ( #54 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
1fd8794974
docs: update third-party.md ( #49 )
3 years ago
021c5ce149
doc: add tips for h2 console config ( #48 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
80fa7403fc
fix: server compression config for gzip statics file ( #47 )
...
* fix: server compression config for gzip statics file
3 years ago
7e023448fc
chore: use markdownlint and add pre commit hook ( #41 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
251729f565
fix: typo in page-variable.md ( #38 )
3 years ago
7993abe690
docs: add the way to get the category tree in the theme development documentation ( #37 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
002bdf3704
docs: add faq page ( #32 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
210681e192
fix: error links in the three-party installation tutorial ( #35 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
ae25c81c19
docs: fix links by team syntax error ( #28 )
3 years ago
9fbabe08fc
docs: add demo site ( #27 )
3 years ago
24b99c52a9
release: create 1.4.17 version ( #26 )
3 years ago
a5c242093b
docs: remove sponsor doc ( #24 )
3 years ago
51e3a89374
release: create 1.4.16 version ( #20 )
3 years ago
65eee57a38
feat: support create versioning docs ( #16 )
3 years ago
Ryan Wang
wxyShine
John Niang
BugKing
Li
舒夏
guqing
WinteWu
Scott_N_Yang
Alanrah
RalstonLiu
Simple-Stark
Nova Kwok
603466551
YYplus
Kent Liao
vayci
cnskis
Lin
daiyum
