halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-10-22 10:58:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
138 Commits 3 Branches 0 Tags
039159dfc016053e728b10fcce7613c486d81e8f
Commit Graph

138 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
BugKing
039159dfc0 docs: add password resetting section in FAQ (#145) 
```release-note
docs: add password resetting section in FAQ
```

在 FAQ 中增加忘记密码处理相关内容。
 2022-12-15 16:13:15 +00:00
Ryan Wang
ec3cba41cf docs: add documentation about compilation (#138) 
提供自编译可执行 JAR 和 Docker 镜像的文档。

Fixes https://github.com/halo-dev/docs/issues/114

/kind documentation

```release-note
None
```
 2022-12-13 13:38:46 +00:00
BugKing
3b43496f60 docs: recover FAQ in sidebar (#142) 
在 PR #124 中误删了侧边栏的常见问题，现在重新添加回来。
```release-note
docs: recover FAQ in sidebar
```
 2022-12-12 09:26:42 +00:00
Simple-Stark
39d34fbea6 docs: improve the developer run guide (#139) 
针对 WIndows 平台优化开发者运行的文档。

/kind documentation

```release-note
None
```
 2022-12-12 04:04:22 +00:00
Ryan Wang
1d43c93f49 feat: improve the quick start section of the introduction (#136) 
更新介绍文档中快速开始的命令，提供初始管理员账号和外部访问链接的环境变量设置。

/kind documentation

```release-note
None
```
 2022-12-09 04:02:14 +00:00
Ryan Wang
749083c815 docs: remove third-party document (#134) 
移除三方安装指南，目前已经不适用于 Halo 2.0

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/131

```release-note
None
```
 2022-12-08 06:50:11 +00:00
Ryan Wang
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
```
 2022-12-08 04:54:10 +00:00
Ryan Wang
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
```
 2022-12-07 10:00:54 +00:00
Ryan Wang
e57d33d369 docs: update tips for migration (#130) 
在迁移文档增加站点需要 HTTPS 的提示。

/kind documentation

```release-note
None
```
 2022-12-06 03:00:15 +00:00
Ryan Wang
fdad517e54 docs: add docker installation tips (#129) 
在部署文档中添加安装 Docker 的提示。

/kind documentation

```release-note
None
```
 2022-12-05 11:04:12 +00:00
Colin Cai
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
```
 2022-12-02 05:13:56 +00:00
Ryan Wang
5c76928800 chore: set 2.0 is latest version (#127) 
将 2.0 版本的文档设置为最新的文档。同时保留 /2.0.0-SNAPSHOT/

/kind documentation

```release-note
None
```
 2022-12-01 01:49:52 +00:00
Ryan Wang
89fb87557c docs: update documentation for Halo 2.0.0 (#125) 
为 Halo 2.0 正式版更新文档。

/kind documentation

```release-note
None
```
 2022-12-01 01:33:51 +00:00
Ryan Wang
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
```
 2022-12-01 01:31:58 +00:00
BugKing
daca55161a docs: add user guide and quick start (#124) 
```release-note
docs: 补充快速入门及用户指南
```
 2022-12-01 00:55:50 +00:00
Ryan Wang
74580f6b43 docs: tips for reload theme configs for theme development (#121) 
/kind documentation

在主题开发文档中添加重载主题配置的提示。

```release-note
None
```
 2022-11-28 10:06:17 +00:00
Ryan Wang
b1ab9a37ef docs: tips for configuring template caching for theme development (#120) 
/kind documentation

在主题开发文档中添加配置模板引擎缓存的提示。

```release-note
None
```
 2022-11-28 01:36:17 +00:00
BugKing
3ee41adb3a Adapt lint script in Windows platform (#119) 
```release-note
None
```
 2022-11-25 10:43:07 +00:00
BugKing
fb88606c73 docs: 更新'写在前面'部分适配2.0变化 (#118) 
/kind documentation

```release-note
None
```
 2022-11-25 09:33:07 +00:00
Ryan Wang
5295fc7748 docs: update documentation for Halo 2.0.0-rc.1 (#117) 
为 Halo 2.0.0-rc.1 更新文档。

/kind documentation

```release-note
None
```
 2022-11-24 15:53:06 +00:00
BugKing
51f76b1c58 docs: fix typo (#116) 
```release-note
None
```
 2022-11-24 10:21:05 +00:00
Ryan Wang
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
```
 2022-11-23 08:39:29 +00:00
Ryan Wang
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
```
 2022-11-18 15:54:22 +00:00
Ryan Wang
f92e5ca387 docs: add basic documentation for theme development (#102) 
添加最基本的主题开发文档，仅编写从创建主题项目到最终预览的部分。

/kind documentation

```release-noe
None
```
 2022-11-18 06:30:26 +00:00
Nova Kwok
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
```
 2022-11-14 14:06:14 +00:00
Ryan Wang
d1cf855f2b docs: update documentation for Halo 2.0.0-beta.1 (#106) 
/kind documentation

为 Halo 2.0.0-beta.1 修改版本号。

```release-note
None
```
 2022-11-11 16:12:13 +00:00
Ryan Wang
0cfaf8cd80 docs: update documentation for docker-compose (#104) 
/kind documentation

1. 移除 `/etc/timezone` 和 `/etc/localtime` 的挂载。
2. PostgreSQL 容器增加 `healthcheck`。

```release-note
None
```
 2022-10-29 14:06:13 +00:00
Ryan Wang
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
```
 2022-10-27 09:16:10 +00:00
Ryan Wang
291023f4f9 docs: add documentation for local environment runs (#101) 
添加本地开发环境运行的文档。

/kind documentation
/cc @halo-dev/sig-docs 

```release-note
None
```
 2022-10-14 03:42:17 +00:00
Ryan Wang
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
```
 2022-10-13 05:10:13 +00:00
Ryan Wang
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
```
 2022-10-13 03:58:14 +00:00
Ryan Wang
99a14110b9 docs: provides Halo 2.0 online demo environment (#98) 
提供 Halo 2.0 的在线演示环境。

/kind documentation

```release-note
None
```
 2022-10-11 03:42:13 +00:00
Ryan Wang
c8633c4ff2 docs: add documentation of docker compose (#97) 
/kind documentation
/cc @halo-dev/sig-docs 

添加使用 Docker Compose 部署的文档。

```release-note
None
```
 2022-10-04 16:22:24 +00:00
Ryan Wang
e25c20b13a docs: update intro (#96) 
更新文档首页。

/kind documentation

```release-note
None
```
 2022-10-01 04:56:18 +00:00
John Niang
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
```
 2022-10-01 04:54:18 +00:00
603466551
7c5457c36f Update third-party.md (#93) 
在极空间nas中使用docker搭建halo
 2022-10-01 01:56:18 +00:00
Ryan Wang
c579f6d3ab docs: refine usage documentation of Halo 2.0 (#94) 
添加 2.0 Alpha 的使用提示。

/kind documentation

```release-note
None
```
 2022-10-01 01:52:18 +00:00
Ryan Wang
95971a90df docs: documentation for Halo 2.0 (#92) 
提供 Halo 2.0 的文档。

TODO list:

- [x] Halo 2.0 的配置文档
- [ ] ~~插件/主题开发的简要文档~~

```release-note
提供 Halo 2.0 的文档
```
 2022-09-30 13:20:18 +00:00
Ryan Wang
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
```
 2022-09-28 15:14:16 +00:00
Ryan Wang
f630eaeca6 docs: add a tip that cannot map halo to a domain subfolder (#90) 
添加不能将 Halo 反向代理到域名子目录的提示。

/kind documentation

```release-note
None
```
 2022-08-31 17:28:14 +00:00
YYplus
322ebdba54 fix: typo in backup-migration.md (#87) 
```release-note
None
```
 2022-08-09 07:42:19 +00:00
Kent Liao
bf0e4ee4f0 fix: linkTag example (#86) 
methods:
* listTeams
* listTeamsByRandom

```release-note
None
```
 2022-08-02 14:14:19 +00:00
vayci
e855ddac26 fix: photoTag listByTeam example (#84) 
Fixes #85 

```release-note
None
```
 2022-08-01 12:36:11 +00:00
Ryan Wang
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>
 2022-07-20 10:01:50 +00:00
Ryan Wang
331c29b3af release: create 1.5.4 version (#82) 
Signed-off-by: Ryan Wang <i@ryanc.cc>
 2022-07-07 11:02:10 +00:00
Ryan Wang
d516c71266 docs: update documentations for Halo 1.5.4 (#81) 
Signed-off-by: Ryan Wang <i@ryanc.cc>
 2022-07-07 09:30:14 +00:00
Ryan Wang
eba654da79 release: create 1.5.3 version (#79) 
Signed-off-by: Ryan Wang <i@ryanc.cc>
 2022-05-09 09:22:18 +00:00
Ryan Wang
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>
 2022-05-09 08:56:13 +00:00
John Niang
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>
 2022-04-25 04:58:17 +00:00
ZXSheng
c680c544ff Add gitee source button in Tencent cloud deployment (#75) 
* Add gitee source button in Tencent cloud deployment

* edit fix
 2022-04-17 08:38:12 +00:00