Ryan Wang
5e70b24ed1
chore: bump docusaurus version to 2.4 ( #228 )
...
升级 Docusaurus 的版本至 2.4
```release-note
None
```
2 years ago
Ryan Wang
3ef8b4c0f9
docs: refactor documentations of user guide ( #225 )
...
重构用户指南的部分内容。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
f9bbef1a63
chore: update site configs ( #227 )
...
1. 修改标题为 `Halo 文档`。
2. Sitemap 排除旧文档的索引,防止 Algolia 额度不够导致无法建索引。
3. 修改页面底部的 Copyright。
4. 修改底部的主题仓库为应用市场。
/kind improvement
```release-note
None
```
2 years ago
Ryan Wang
b3382b0170
docs: fix typos and word case ( #226 )
...
修正部分单词错误和写法错误。
/kind improvement
```release-note
None
```
2 years ago
airbo
81cdc88b31
docs: update form schema link ( #224 )
...
Fix #223
```release-note
None
```
2 years ago
Ryan Wang
5d74edea8f
docs: update documentation for Halo 2.6 ( #222 )
...
为 Halo 2.6 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Simple
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
Ryan Wang
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
Simple
e7cce8f366
docs: fix incorrect configuration instructions in runtime-mode.md ( #221 )
...
/kind documentation
Closes #220
```release-note
None
```
2 years ago
Ryan Wang
9daf914879
docs: refine documentation of installation ( #215 )
...
优化安装文档。
1. 优化安装完成之后的提示。
2. 优化 Docker 启动参数的描述。
3. Docker 的数据库配置参数添加 MariaDB 的说明。
4. 移动反向代理方式的顺序。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
bc5fe02283
docs: docs: update documentation for Halo 2.5 ( #212 )
...
为 Halo 2.5 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
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
wxyShine
fe704e8036
Add installation method while MySQL exists ( #201 )
...
Add docker-compose to use the existing Mysql deployment method
```release-note
None
```
2 years ago
Ryan Wang
862756a76c
docs: update documentation for Halo 2.4.1 ( #207 )
...
为 Halo 2.4.1 更新文档。
/kind documentation
```release-note
None
```
2 years ago
John Niang
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
Ryan Wang
4edbf7e639
docs: update documentation for Halo 2.4 ( #203 )
...
为 Halo 2.4 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
96feaf5631
typo: fix typo in the description of external url ( #202 )
...
修正 Docker 参数 `halo.external-url` 描述中的错别字。
/kind documentation
```release-note
None
```
2 years ago
BugKing
aaa258d244
docs: add docs for installation with 1Panel ( #200 )
...
增加使用 1Panel 进行部署的文档。
Fixes #199
```release-note
None
```
2 years ago
Li
1d939e714f
docs: add target attribute documentation for menu item ( #191 )
...
添加主题开发 - 导航菜单中关于 `target` 属性的文档
/kind documentation
Fixes #190
```release-note
None
```
2 years ago
Ryan Wang
0998964dca
docs: update documentations for building and running in development env ( #198 )
...
因为目前已经将 Console 合并到了 Halo 主仓库,所以需要修改开发环境运行和构建的文档。
See https://github.com/halo-dev/halo/issues/3393
Fixes #197
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
a23ea5940f
docs: update documentation for Halo 2.3 ( #196 )
...
为 Halo 2.3 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
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
Li
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
BugKing
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
guqing
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
WinteWu
4d59c627c5
fix: nginx link error in docker-compose page ( #186 )
...
```release-note
None
```
2 years ago
Scott_N_Yang
a324a86fc3
docs: add documentation of traefik proxy ( #172 )
...
增加 Traefik 与 Halo 配合使用的文档
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
e89334a6b4
docs: add documentation for custom template tag ( #179 )
...
添加 Halo 为 Thymeleaf 提供的 Halo 专有标签的文档。
/kind documentation
Fixes #160
```release-note
None
```
2 years ago
Ryan Wang
bc4497eeac
docs: bump docusaurus version to 2.3.0 ( #184 )
...
升级 docusaurus 的版本:https://github.com/facebook/docusaurus/releases/tag/v2.3.0
/kind improvement
```release-note
None
```
2 years ago
Ryan Wang
6f8b67c9f0
docs: add documentation for template engine global variables ( #180 )
...
添加 Halo 为模板引擎提供的全局变量的文档。
/kind documentation
Fixes #161
```release-note
None
```
2 years ago
Ryan Wang
b8a50b78b6
docs: remove version tips ( #183 )
...
Fixes #182
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
bf412ac04e
docs: add documentation for update docker image to upgrade halo ( #177 )
...
添加更新 Docker 镜像的文档。
/kind documentation
Fixes #150
```release-note
None
```
2 years ago
Ryan Wang
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
Ryan Wang
922502a9d3
docs: add tips of console proxy ( #178 )
...
在开发环境文档中添加 Console 代理的提示。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
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
Ryan Wang
55e5f60aee
docs: update documentation for Halo 2.2 ( #174 )
...
为 Halo 2.2 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
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
Ryan Wang
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
Ryan Wang
8c3d6d097e
fix: wrong example of contributor finder api ( #166 )
...
修复关于 Contributor 的 Finder API 示例错误的问题。
/kind documentation
Fixes #158
```release-note
None
```
2 years ago
Ryan Wang
1165cff265
docs: add documentation for annotations form definition ( #165 )
...
添加 Annotations Form 表单定义和使用的文档。
Fixes #154
/kind documentation
```release-note
None
```
2 years ago
John Niang
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
Ryan Wang
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
BugKing
f89f0beadf
docs: refine user guide documentation for Halo 2.1.0 ( #159 )
...
为 Halo 2.1 完善用户使用指南。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/157
```release-note
None
```
2 years ago
Alanrah
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
RalstonLiu
1416be911c
docs: add documentation for use with Nginx Proxy Manager ( #149 )
...
添加nginxproxymanager的文档,之前PR关闭了
```release-note
None
```
2 years ago
BugKing
2ec6fbb8af
Fix illustration for uninstalling plugins ( #152 )
...
```release-note
fix: 卸载插件配图错误
````
Fixes #151
2 years ago
Ryan Wang
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
Ryan Wang
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
Ryan Wang
dcb7a89b82
docs: add description of the docker environment variable ( #137 )
...
为部署文档提供 Docker 环境变量的解释。
/kind documentation
```release-note
None
```
2 years ago