pc5kflswa
/
docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update documentation for Halo 2.0.0-rc.1 (#117)

Browse Source 
为 Halo 2.0.0-rc.1 更新文档。

/kind documentation

```release-note
None
```
JohnNiang-patch-1
Ryan Wang 2 years ago committed by GitHub
parent 51f76b1c58
commit 5295fc7748
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File

7
docs/developer-guide/core/run.md
Unescape View File

@ -105,9 +105,8 @@ VITE v3.1.6 ready in 638 ms
6. 最终访问 `http://localhost:8090/console` 即可进入控制台。访问 `http://localhost:8090` 即可进入站点首页。 6. 最终访问 `http://localhost:8090/console` 即可进入控制台。访问 `http://localhost:8090` 即可进入站点首页。
:::info 注意 :::info 注意
目前 Beta 版本有以下几个使用注意事项： 目前 RC 版本有以下几个使用注意事项：
::: :::
1. 由于目前尚未完成初始化程序，所以安装完成之后没有默认主题，你可以访问 <https://github.com/halo-sigs/awesome-halo> 查阅所有支持 2.0 的主题，并在后台主题管理页面手动安装。 1. 由于目前评论组件被插件化且暂不支持提供默认插件，所以如果要体验完整的评论功能，需要手动在后台安装 <https://github.com/halo-sigs/plugin-comment-widget> 评论组件插件。
2. 同上，由于目前评论组件也被插件化，所以如果要体验完整的评论功能，需要手动在后台安装 <https://github.com/halo-sigs/plugin-comment-widget> 评论组件插件。 2. 目前 2.0 已支持的主题和插件会同步到 <https://github.com/halo-sigs/awesome-halo>，你可以在对应仓库的 release 下载最新的主题或插件。
3. 目前 2.0 已支持的主题和插件会同步到 <https://github.com/halo-sigs/awesome-halo>，你可以在对应仓库的 release 下载最新的主题或插件。

19
docs/getting-started/install/docker-compose.md
Unescape View File

@ -9,7 +9,7 @@ description: 使用 Docker Compose 部署
## 创建容器组 ## 创建容器组
可用的 Halo 2.0.0-beta.2 的 Docker 镜像： 可用的 Halo 2.0.0-rc.1 的 Docker 镜像：
- [halohub/halo-dev](https://hub.docker.com/r/halohub/halo-dev) - [halohub/halo-dev](https://hub.docker.com/r/halohub/halo-dev)
- [ghcr.io/halo-dev/halo-dev](https://github.com/halo-dev/halo/pkgs/container/halo-dev) - [ghcr.io/halo-dev/halo-dev](https://github.com/halo-dev/halo/pkgs/container/halo-dev)
@ -43,11 +43,11 @@ description: 使用 Docker Compose 部署
services: services:
halo_next: halo_next:
image: halohub/halo-dev:2.0.0-beta.2 image: halohub/halo-dev:2.0.0-rc.1
container_name: halo_next container_name: halo_next
restart: on-failure:3 restart: on-failure:3
volumes: volumes:
- ./:/root/halo-next - ./:/root/.halo2
ports: ports:
- "8090:8090" - "8090:8090"
environment: environment:
@ -66,7 +66,7 @@ description: 使用 Docker Compose 部署
services: services:
halo_next: halo_next:
image: halohub/halo-dev:2.0.0-beta.2 image: halohub/halo-dev:2.0.0-rc.1
container_name: halo_next container_name: halo_next
restart: on-failure:3 restart: on-failure:3
depends_on: depends_on:
@ -75,7 +75,7 @@ description: 使用 Docker Compose 部署
networks: networks:
halo_network: halo_network:
volumes: volumes:
- ./:/root/halo-next - ./:/root/.halo2
ports: ports:
- "8090:8090" - "8090:8090"
environment: environment:
@ -129,11 +129,10 @@ description: 使用 Docker Compose 部署
## 使用 ## 使用
目前 Beta 版本有以下几个使用注意事项： 目前 RC 版本有以下几个使用注意事项：
1. 由于目前尚未完成初始化程序，所以安装完成之后没有默认主题，你可以访问 <https://github.com/halo-sigs/awesome-halo> 查阅所有支持 2.0 的主题，并在后台主题管理页面手动安装。 1. 由于目前评论组件被插件化且暂不支持提供默认插件，所以如果要体验完整的评论功能，需要手动在后台安装 <https://github.com/halo-sigs/plugin-comment-widget> 评论组件插件。
2. 同上，由于目前评论组件也被插件化，所以如果要体验完整的评论功能，需要手动在后台安装 <https://github.com/halo-sigs/plugin-comment-widget> 评论组件插件。 2. 目前 2.0 已支持的主题和插件会同步到 <https://github.com/halo-sigs/awesome-halo>，你可以在对应仓库的 release 下载最新的主题或插件。
3. 目前 2.0 已支持的主题和插件会同步到 <https://github.com/halo-sigs/awesome-halo>，你可以在对应仓库的 release 下载最新的主题或插件。
## 反向代理 ## 反向代理
@ -211,7 +210,7 @@ reverse_proxy 127.0.0.1:8090
```yaml {3} ```yaml {3}
services: services:
halo_next: halo_next:
image: halohub/halo-dev:2.0.0-beta.2 image: halohub/halo-dev:2.0.0-rc.1
container_name: halo_next container_name: halo_next
``` ```

15
docs/getting-started/install/docker.md
Unescape View File

@ -9,7 +9,7 @@ description: 使用 Docker 部署
## 使用 Docker 镜像 ## 使用 Docker 镜像
可用的 Halo 2.0.0-beta.2 的 Docker 镜像： 可用的 Halo 2.0.0-rc.1 的 Docker 镜像：
- [halohub/halo-dev](https://hub.docker.com/r/halohub/halo-dev) - [halohub/halo-dev](https://hub.docker.com/r/halohub/halo-dev)
- [ghcr.io/halo-dev/halo-dev](https://github.com/halo-dev/halo/pkgs/container/halo-dev) - [ghcr.io/halo-dev/halo-dev](https://github.com/halo-dev/halo/pkgs/container/halo-dev)
@ -23,10 +23,10 @@ description: 使用 Docker 部署
-it -d \ -it -d \
--name halo-next \ --name halo-next \
-p 8090:8090 \ -p 8090:8090 \
-v ~/halo-next:/root/halo-next \ -v ~/.halo2:/root/.halo2 \
-e HALO_EXTERNAL_URL=http://localhost:8090/ \ -e HALO_EXTERNAL_URL=http://localhost:8090/ \
-e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
halohub/halo-dev:2.0.0-beta.2 halohub/halo-dev:2.0.0-rc.1
``` ```
:::info :::info
@ -37,7 +37,7 @@ description: 使用 Docker 部署
- **-d**：后台运行容器 - **-d**：后台运行容器
- **--name**：为容器指定一个名称 - **--name**：为容器指定一个名称
- **-p**：端口映射，格式为 `主机(宿主)端口:容器端口` ，可在 `application.yaml` 配置。 - **-p**：端口映射，格式为 `主机(宿主)端口:容器端口` ，可在 `application.yaml` 配置。
- **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/halo-next`，后者不能修改。 - **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/.halo2`，后者不能修改。
- **-e**：环境变量 - **-e**：环境变量
- `HALO_EXTERNAL_URL`: 外部可访问的链接。例如：<https://域名/> - `HALO_EXTERNAL_URL`: 外部可访问的链接。例如：<https://域名/>
- `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户（admin）的初始化密码。如果该环境变量没有设置，系统将会生成随机密码并打印在日志中。 - `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户（admin）的初始化密码。如果该环境变量没有设置，系统将会生成随机密码并打印在日志中。
@ -50,11 +50,10 @@ description: 使用 Docker 部署
## 使用 ## 使用
目前 Beta 版本有以下几个使用注意事项： 目前 RC 版本有以下几个使用注意事项：
1. 由于目前尚未完成初始化程序，所以安装完成之后没有默认主题，你可以访问 <https://github.com/halo-sigs/awesome-halo> 查阅所有支持 2.0 的主题，并在后台主题管理页面手动安装。 1. 由于目前评论组件被插件化且暂不支持提供默认插件，所以如果要体验完整的评论功能，需要手动在后台安装 <https://github.com/halo-sigs/plugin-comment-widget> 评论组件插件。
2. 同上，由于目前评论组件也被插件化，所以如果要体验完整的评论功能，需要手动在后台安装 <https://github.com/halo-sigs/plugin-comment-widget> 评论组件插件。 2. 目前 2.0 已支持的主题和插件会同步到 <https://github.com/halo-sigs/awesome-halo>，你可以在对应仓库的 release 下载最新的主题或插件。
3. 目前 2.0 已支持的主题和插件会同步到 <https://github.com/halo-sigs/awesome-halo>，你可以在对应仓库的 release 下载最新的主题或插件。
## 反向代理 ## 反向代理

2
docs/getting-started/prepare.md
Unescape View File

@ -80,7 +80,7 @@ Halo 理论上可以运行在任何支持 Java 的平台。
### 工作目录 ### 工作目录
指 Halo 所依赖的工作目录，在 Halo 运行的时候会在系统当前用户目录下产生一个 `.halo-next` 的文件夹，绝对路径为 `~/.halo-next`。由于这个工作目录是固定的，所以上面所说的 `运行包`不限制所存放的位置，里面通常包含下列目录或文件： 指 Halo 所依赖的工作目录，在 Halo 运行的时候会在系统当前用户目录下产生一个 `.halo2` 的文件夹，绝对路径为 `~/.halo2`。由于这个工作目录是固定的，所以上面所说的 `运行包`不限制所存放的位置，里面通常包含下列目录或文件：
1. `db`：存放 H2 Database 的物理文件，如果你使用其他数据库，那么不会存在这个目录。 1. `db`：存放 H2 Database 的物理文件，如果你使用其他数据库，那么不会存在这个目录。
2. `themes`：里面包含用户所安装的主题。 2. `themes`：里面包含用户所安装的主题。

8
docs/intro.md
Unescape View File

@ -13,7 +13,7 @@ slug: /
</a> </a>
</p> </p>
<p align="center"><b>Halo</b> [ˈheɪloʊ]，一款现代化的开源博客/CMS系统，值得一试。</p> <p align="center"><b>Halo</b> [ˈheɪloʊ]，好用又强大的开源建站工具。</p>
<p align="center"> <p align="center">
<a href="https://github.com/halo-dev/halo/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/halo-dev/halo.svg?style=flat-square&include_prereleases" /></a> <a href="https://github.com/halo-dev/halo/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/halo-dev/halo.svg?style=flat-square&include_prereleases" /></a>
@ -23,7 +23,7 @@ slug: /
<a href="https://github.com/halo-dev/halo/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/halo-dev/halo/Halo%20CI?style=flat-square" /></a> <a href="https://github.com/halo-dev/halo/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/halo-dev/halo/Halo%20CI?style=flat-square" /></a>
<br /> <br />
<a href="https://halo.run">官网</a> <a href="https://halo.run">官网</a>
<a href="https://docs.halo.run/2.0.0-SNAPSHOT">文档（2.0 Beta）</a> <a href="https://docs.halo.run/2.0.0-SNAPSHOT">文档（2.0 RC）</a>
<a href="https://bbs.halo.run">社区</a> <a href="https://bbs.halo.run">社区</a>
<a href="https://gitee.com/halo-dev">Gitee</a> <a href="https://gitee.com/halo-dev">Gitee</a>
<a href="https://t.me/halo_dev">Telegram 频道</a> <a href="https://t.me/halo_dev">Telegram 频道</a>
@ -33,7 +33,7 @@ slug: /
## 注意 ## 注意
当前分支为 Halo 2.0 的开发分支，目前 Halo 2.0 处于 Beta 测试阶段，无法从 1.5 直接升级，也不建议在生产环境使用。稳定版本（Halo 1.x）请查阅以下地址： 当前分支为 Halo 2.0 的开发分支，目前 Halo 2.0 处于 RC 阶段，暂时无法从 1.5 直接升级，不建议在生产环境使用。稳定版本（Halo 1.x）请查阅以下地址：
- 1.5 分支：<https://github.com/halo-dev/halo/tree/release-1.5> - 1.5 分支：<https://github.com/halo-dev/halo/tree/release-1.5>
- 1.6 分支：<https://github.com/halo-dev/halo/tree/release-1.6> - 1.6 分支：<https://github.com/halo-dev/halo/tree/release-1.6>
@ -44,7 +44,7 @@ slug: /
### Docker ### Docker
```bash ```bash
docker run -it -d --name halo-next -p 8090:8090 -v ~/halo-next:/root/halo-next --restart=unless-stopped halohub/halo-dev:2.0.0-beta.2 docker run -it -d --name halo-next -p 8090:8090 -v ~/.halo2:/root/.halo2 --restart=unless-stopped halohub/halo-dev:2.0.0-rc.1
``` ```
详细部署文档请查阅：<https://docs.halo.run/2.0.0-SNAPSHOT/getting-started/install/docker> 详细部署文档请查阅：<https://docs.halo.run/2.0.0-SNAPSHOT/getting-started/install/docker>

Write Preview
Loading…
Cancel
Save