docs: update documentations for building and running in development env (#198)

因为目前已经将 Console 合并到了 Halo 主仓库,所以需要修改开发环境运行和构建的文档。

See https://github.com/halo-dev/halo/issues/3393

Fixes #197 

/kind documentation

```release-note
None
```
JohnNiang-patch-1
Ryan Wang 2 years ago committed by GitHub
parent a23ea5940f
commit 0998964dca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -27,44 +27,40 @@ cd halo
git checkout v2.0.0
```
```bash
git clone https://github.com/halo-dev/console
# 或者使用 ssh 的方式 clone推荐
git clone git@github.com:halo-dev/console.git
# 切换到最新的 tag
cd console
git checkout v2.0.0
```
:::tip
请务必按照以上要求切换到最新的 tag而不是直接使用 main 分支构建main 分支是我们的开发分支。此文档以 `2.0.0` 为例,查看最新的 tag 可使用 `git tag --column` 查看。
:::
:::warning
从 2.4.0 开始Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
:::
## 构建 Console
```bash
cd path/to/console
cd path/to/halo
```
Linux / macOS 平台:
```bash
pnpm install
make -C console build
```
Windows 平台:
```bash
cd console
pnpm install
pnpm build:packages
```
```bash
pnpm build
```
构建完成之后,在 console 目录下产生的 `dist` 目录即为构建完成的文件。最后将 `dist` 目录的所有文件复制到 halo 项目的 `src/main/resources/console` 目录。
## 构建 Fat Jar
构建之前需要修改 `gradle.properties` 中的 `version` 为当前 tag 的版本号,如:`version=2.0.0`

@ -11,9 +11,9 @@ description: 开发环境运行的指南
目前如果需要完整的运行 Halo总共需要三个部分
1. Halo 主项目([halo-dev/halo](https://github.com/halo-dev/halo))
2. Console 控制台([halo-dev/console](https://github.com/halo-dev/console))
3. 主题
1. Halo 主项目[halo-dev/halo](https://github.com/halo-dev/halo)
2. Console 控制台(托管在 Halo 主项目)
3. 主题Halo 主项目内已包含默认主题)
:::info 说明
当前 Halo 主项目并不会将 Console 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 Console 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 Console 到 Halo 主项目。
@ -31,29 +31,33 @@ git clone https://github.com/halo-dev/halo
git clone git@github.com:halo-dev/halo.git
```
```bash
git clone https://github.com/halo-dev/console
# 或者使用 ssh 的方式 clone推荐
:::warning
从 2.4.0 开始Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
git clone git@github.com:halo-dev/console.git
```
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
:::
## 运行 Console
```bash
cd path/to/console
cd path/to/halo
```
Linux / macOS 平台:
```bash
pnpm install
make -C console dev
```
Windows 平台:
```bash
cd console
pnpm install
pnpm build:packages
```
```bash
pnpm dev
```

Loading…
Cancel
Save