017ec7aaa9
docs: add docs for plugin ExtensionGetter ( #388 )
...
#### What this PR does / why we need it:
添加 ExtensionGetter 的开发者文档及示例。
see https://github.com/halo-dev/halo/pull/6365
#### Does this PR introduce a user-facing change?
```release-note
None
```
4 months ago
bf152a8458
docs: 增加离线部署文档 ( #386 )
5 months ago
1714c0f496
docs: add documentations for plugin detail modal component ( #385 )
...
添加 2.17.0 添加的 PluginDetailModal 组件的文档。
/kind documentation
```release-note
None
```
5 months ago
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
```
5 months ago
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
```
5 months ago
d61ebe4f62
docs: add api client usage docs for plugin ( #374 )
...
为插件提供 api-client 的使用文档。
/kind documentation
```release-note
None
```
5 months ago
70d9c65698
docs: add detailed guide on how to use plugin settings ( #375 )
...
### What this PR does?
新增关于如何使用插件配置的文档
see also https://github.com/halo-dev/halo/pull/6141
```release-note
None
```
5 months ago
78416a1337
docs: add documentations for app store plugin ( #365 )
...
添加内置应用市场的使用说明，以及更新插件和主题的安装文档。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/362
```release-note
None
```
6 months ago
c9f55fac58
docs: tencent cloud lighthouse ( #354 )
...
添加使用腾讯云轻量应用服务器的应用模板部署的文档。
/kind documentation
```release-note
None
```
6 months ago
b8b5a4e34d
doc: add doc for template head processor extension point ( #348 )
7 months ago
2c80278f59
Add documentation for websocket ( #341 )
...
See https://github.com/halo-dev/halo/pull/5662#issuecomment-2049166868 for more.
```release-note
None
```
7 months ago
0ce0fd13a5
docs: add documentation for user tab ( #340 )
...
为用户资料选项卡和个人中心的资料选项卡扩展点添加文档。
Ref https://github.com/halo-dev/halo/pull/5763
/kind documentation
```release-note
None
```
7 months ago
08ebdfc95f
Add documentation for authentication webfilter extension points ( #320 )
...
* Add documentation for authentication webfilter extension points
* Refine requirements of extension point definition
9 months ago
97e0b2b526
refactor: documentation structure ( #310 )
...
重构文档结构，将开发者文档与使用文档分开。
<img width="641" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/baed360c-997b-443c-9a8e-cc53e268b8f4 ">
<img width="766" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/08326aab-d474-4075-bdc9-c628a39ba715 ">
Note: 此改动不造成死链。
```release-note
None
```
10 months ago
2ebc8ca714
docs: add documentation for deployment using a jar file ( #305 )
...
添加使用 Jar 文件部署的文档。
/kind documentation
```release-note
None
```
10 months ago
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>
10 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
d80d49e1ac
docs: remove oneinstack related documentations ( #275 )
...
移除 OneinStack 相关文档，目前 OneinStack 已经完全无法使用。
https://oneinstack.com/
```release-note
None
```
1 year ago
871c231a7c
docs: add sponsor page ( #265 )
...
添加赞助页面。
/kind documentation
```release-note
None
```
1 year ago
587cd952d6
docs: add halo on podman ( #256 )
...
添加使用 Podman 部署Halo的方法.
```release-note
None
```
1 year ago
b25183347f
docs: add backup and restore documentations ( #237 )
...
添加备份和恢复的使用文档。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/236
```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
aaa258d244
docs: add docs for installation with 1Panel ( #200 )
...
增加使用 1Panel 进行部署的文档。
Fixes #199
```release-note
None
```
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
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
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
1165cff265
docs: add documentation for annotations form definition ( #165 )
...
添加 Annotations Form 表单定义和使用的文档。
Fixes #154
/kind documentation
```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
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
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
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
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
f92e5ca387
docs: add basic documentation for theme development ( #102 )
...
添加最基本的主题开发文档，仅编写从创建主题项目到最终预览的部分。
/kind documentation
```release-noe
None
```
2 years ago
291023f4f9
docs: add documentation for local environment runs ( #101 )
...
添加本地开发环境运行的文档。
/kind documentation
/cc @halo-dev/sig-docs
```release-note
None
```
2 years ago
c8633c4ff2
docs: add documentation of docker compose ( #97 )
...
/kind documentation
/cc @halo-dev/sig-docs
添加使用 Docker Compose 部署的文档。
```release-note
None
```
2 years ago
95971a90df
docs: documentation for Halo 2.0 ( #92 )
...
提供 Halo 2.0 的文档。
TODO list:
- [x] Halo 2.0 的配置文档
- [ ] ~~插件/主题开发的简要文档~~
```release-note
提供 Halo 2.0 的文档
```
2 years ago
2e421f26ab
chore: bump docusaurus to 2.1.0 ( #91 )
...
升级 docusaurus 到 2.1.0
- https://github.com/facebook/docusaurus/releases/tag/v2.0.0
- https://github.com/facebook/docusaurus/releases/tag/v2.1.0
```release-note
none
```
2 years ago
c7fcd588f0
docs: remove tencent developer labs sidebar link ( #67 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
5a2a4ccad7
doc: add installation document using docker-compose ( #58 )
3 years ago
002bdf3704
docs: add faq page ( #32 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
a5c242093b
docs: remove sponsor doc ( #24 )
3 years ago
8db239cb9a
docs: add a tutorial on deploying halo using docker and MySQL ( #13 )
...
* feat: add a tutorial on deploying halo using docker and MySQL
* refactor: remove docker-mysql route config
* feat: supplementary doc
* feat: 补充文档
* docs: update docker-mysql
* docs: update docker-mysql
* docs: update docker-mysql
* docs: update docker-mysql
* fix: space between Chinese and English
3 years ago
Takagi
BugKing
Ryan Wang
guqing
John Niang
John
Scott_N_Yang
RalstonLiu
Moshi