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
d1cf855f2b
docs: update documentation for Halo 2.0.0-beta.1 ( #106 )
...
/kind documentation
为 Halo 2.0.0-beta.1 修改版本号。
```release-note
None
```
2 years ago
0cfaf8cd80
docs: update documentation for docker-compose ( #104 )
...
/kind documentation
1. 移除 `/etc/timezone` 和 `/etc/localtime` 的挂载。
2. PostgreSQL 容器增加 `healthcheck`。
```release-note
None
```
2 years ago
9d31a377e5
docs: update documentation for Halo 2.0.0-alpha.3 ( #103 )
...
更新 2.0.0 alpha 的版本号。 https://github.com/halo-dev/halo/releases/tag/v2.0.0-alpha.3
/kind documentation
```release-note
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
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
c8633c4ff2
docs: add documentation of docker compose ( #97 )
...
/kind documentation
/cc @halo-dev/sig-docs
添加使用 Docker Compose 部署的文档。
```release-note
None
```
2 years ago
e25c20b13a
docs: update intro ( #96 )
...
更新文档首页。
/kind documentation
```release-note
None
```
2 years ago
09a71990e1
Rectify docker running command ( #95 )
...
/kind bug
原始的 Docker 运行命令无法在 zsh 下正常执行：
```bash
╰─❯ docker run \
-it -d \
--name halo-next \
-p 8090:8090 \
-v ~/halo-next:/root/halo-next \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \ # 请修改外部访问链接
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ # 请修改管理员密码
-e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo-dev:2.0.0-alpha.1
docker: invalid reference format.
See 'docker run --help'.
zsh: command not found: -e
zsh: command not found: -e
```
去掉注释部分可正常执行：
```bash
╰─❯ docker run \
-it -d \
--name halo-next \
-p 8090:8090 \
-v ~/halo-next:/root/halo-next \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo-dev:2.0.0-alpha.1
55d9de646deb1ec99d22210f45be44b83ec76186d5cbce00983f57d9ff46d834
```
```release-note
None
```
2 years ago
7c5457c36f
Update third-party.md ( #93 )
...
在极空间nas中使用docker搭建halo
2 years ago
c579f6d3ab
docs: refine usage documentation of Halo 2.0 ( #94 )
...
添加 2.0 Alpha 的使用提示。
/kind documentation
```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
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
d516c71266
docs: update documentations for Halo 1.5.4 ( #81 )
...
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
797ef03b1c
docs: update documentations for Halo 1.5.3 ( #78 )
...
* docs: update documentations for Halo 1.5.3
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: rollback intro.md
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
c680c544ff
Add gitee source button in Tencent cloud deployment ( #75 )
...
* Add gitee source button in Tencent cloud deployment
* edit fix
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
eeb035f7dc
docs: update documentations for Halo 1.5.2 ( #68 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
4537023e03
docs: add docker-compose upgrade method ( #65 )
...
* 增加docker-compose安装方式
* 增加docker-compose安装方式的侧边目录
* 根据修改意见进行完善，增加halo+redis+mysql编排
* Update docs/getting-started/install/docker-compose.md
Co-authored-by: John Niang <johnniang@fastmail.com>
* Update docs/getting-started/install/docker-compose.md
Co-authored-by: John Niang <johnniang@fastmail.com>
* Update docs/getting-started/install/docker-compose.md
Co-authored-by: John Niang <johnniang@fastmail.com>
* 解决重复创建./halo目录导致的自定义数据库application.yaml不生效的问题。
解决重复创建./halo目录导致的自定义数据库application.yaml不生效的问题。
* 根据修改建议，调整至其他中
* 将doceker-compose文档移动到other目录下
* 更正调整目录后文档内的引用路径
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* Update docs/getting-started/install/other/docker-compose.md
Co-authored-by: Ryan Wang <i@ryanc.cc>
* remove environment variable whitespace
* MySQL容器启动时自动初始化DB Schema
* MySQL容器启动时自动初始化DB Schema
* 修改容器重启策略，使用绝对路径映射目录
* 增加docker-compose更新方式
* Modify the suffix spelling of the yaml file
* 调整更新容器组文档位置
* 解决pnpm lint提示的错误
* 解决pnpm lint提示的错误
Co-authored-by: “MoshiCoCo” <“junzhou2016@outlook.com”>
Co-authored-by: John Niang <johnniang@fastmail.com>
Co-authored-by: Ryan Wang <i@ryanc.cc>
Co-authored-by: MoshiCoCo <junzhou2016@outlook.com>
3 years ago
c7fcd588f0
docs: remove tencent developer labs sidebar link ( #67 )
...
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
5a2a4ccad7
doc: add installation document using docker-compose ( #58 )
3 years ago
9c9185e681
release: create 1.5.1 version ( #63 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
ba4a10a5f6
doc: update docs for halo 1.5.1 ( #62 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
38d1bfde8c
chore: actions add check step ( #61 )
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
db2cc95474
chore: create OWNERS ( #60 )
...
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
55b34b2e94
doc: update documents for Halo 1.5 ( #51 )
3 years ago
ae58e68f48
doc: add redis configuration documents ( #53 )
3 years ago
1fd8794974
docs: update third-party.md ( #49 )
3 years ago
12fff98472
docs: update third-party.md ( #50 )
3 years ago
021c5ce149
doc: add tips for h2 console config ( #48 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
Ryan Wang
Nova Kwok
John Niang
603466551
YYplus
Kent Liao
vayci
ZXSheng
Moshi
luoxx
cnskis