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
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
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
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
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
3b43496f60
docs: recover FAQ in sidebar ( #142 )
...
在 PR #124 中误删了侧边栏的常见问题，现在重新添加回来。
```release-note
docs: recover FAQ in sidebar
```
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
212b5aa56b
docs: update docker-compose.md for PostgreSQL PGUSER env ( #128 )
...
add PGUSER to fix `FATAL: role "root" does not exist` warning.
```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
89fb87557c
docs: update documentation for Halo 2.0.0 ( #125 )
...
为 Halo 2.0 正式版更新文档。
/kind documentation
```release-note
None
```
2 years ago
779e584dbd
docs: adding documentation for migration from 1.x ( #115 )
...
添加从 1.x 迁移的文档。
See preview link at <https://halo-docs-git-fork-ruibaby-docs-add-docs-for-mi-9c13bf-halo-dev.vercel.app/2.0.0-SNAPSHOT/getting-started/migrate-from-1.x >.
```release-note
None
```
2 years ago
daca55161a
docs: add user guide and quick start ( #124 )
...
```release-note
docs: 补充快速入门及用户指南
```
2 years ago
74580f6b43
docs: tips for reload theme configs for theme development ( #121 )
...
/kind documentation
在主题开发文档中添加重载主题配置的提示。
```release-note
None
```
2 years ago
b1ab9a37ef
docs: tips for configuring template caching for theme development ( #120 )
...
/kind documentation
在主题开发文档中添加配置模板引擎缓存的提示。
```release-note
None
```
2 years ago
3ee41adb3a
Adapt lint script in Windows platform ( #119 )
...
```release-note
None
```
2 years ago
fb88606c73
docs: 更新'写在前面'部分适配2.0变化 ( #118 )
...
/kind documentation
```release-note
None
```
2 years ago
5295fc7748
docs: update documentation for Halo 2.0.0-rc.1 ( #117 )
...
为 Halo 2.0.0-rc.1 更新文档。
/kind documentation
```release-note
None
```
2 years ago
51f76b1c58
docs: fix typo ( #116 )
...
```release-note
None
```
2 years ago
aee974185e
docs: refine theme development documentation ( #110 )
...
完善 Halo 2.0 主题开发的文档。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/109
TODO list:
- [x] 准备工作 - 提供从搭建 Halo 开发环境到成功应用一个新的主题的过程。
- [x] 目录结构 - 详细解释一个主题的目录构成，包括每一个目录和文件的作用。
- [x] 配置文件 - 提供 `theme.yaml` 的各个配置的解释。
- [x] 设置选项 - 讲解如何在主题模板中使用主题定义的 `settings.yaml` 配置项。**注意：关于 settings.yaml 或许可以单独出一篇文档，因为插件也需要用到。主题和插件的文档只需要单独讲解如何使用**
- [x] 静态资源 - 讲解静态资源的引用。
- [x] 核心路由 - 列出 Halo 核心提供的路由以及模板，其中需要包括 `文章/自定义页面/分类的自定义模板` 的讲解
- [x] 模板变量 - 讲解系统内提供的路由对应模板中包含的变量。
- [x] Finder APIs - 讲解数据获取 API 的使用。
- [x] 常用代码片段 - 提供一些在主题开发中常用的代码片段，比如如何定义一个 `layout.html`，如何结构化渲染一个菜单或者文章分类等。
```release-note
None
```
2 years ago
10e29f827c
docs: update documentation for Halo 2.0.0-beta.2 ( #111 )
...
/kind documentation
为 [Halo 2.0.0-beta.2](https://github.com/halo-dev/halo/releases/tag/v2.0.0-beta.2 ) 修改版本号。
```release-note
None
```
2 years ago
f92e5ca387
docs: add basic documentation for theme development ( #102 )
...
添加最基本的主题开发文档，仅编写从创建主题项目到最终预览的部分。
/kind documentation
```release-noe
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
guqing
WinteWu
Scott_N_Yang
Ryan Wang
John Niang
BugKing
Alanrah
RalstonLiu
Simple-Stark
Colin Cai
Nova Kwok