Skip to content

Commit

Permalink
修改说明文档
Browse files Browse the repository at this point in the history
  • Loading branch information
wenjing-xin committed Jun 3, 2024
1 parent 1a50ba7 commit 696a45d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 33 deletions.
36 changes: 4 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# plugin-starter

Halo 2.0 插件开发快速开始模板。
# plugin-artalk
为 halo2.0 集成artalk评论区

## 开发环境

Expand All @@ -27,8 +26,8 @@ git clone [email protected]:{your_github_id}/plugin-starter.git
cd path/to/plugin-starter
```

### 运行方式 1(推荐)

### 本地开发(推荐)
其他方式参见 halo 文档
> 此方式需要本地安装 Docker
```bash
Expand All @@ -46,31 +45,4 @@ cd path/to/plugin-starter
# Windows
./gradlew.bat haloServer
```

执行此命令后,会自动创建一个 Halo 的 Docker 容器并加载当前的插件,更多文档可查阅:<https://docs.halo.run/developer-guide/plugin/basics/devtools>

### 运行方式 2

> 此方式需要使用源码运行 Halo
编译插件:

```bash
# macOS / Linux
./gradlew build

# Windows
./gradlew.bat build
```

修改 Halo 配置文件:

```yaml
halo:
plugin:
runtime-mode: development
fixedPluginPath:
- "/path/to/plugin-starter"
```
最后重启 Halo 项目即可。
2 changes: 1 addition & 1 deletion settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ pluginManagement {
gradlePluginPortal()
}
}
rootProject.name = 'plugin-starter'
rootProject.name = 'plugin-artalk'

0 comments on commit 696a45d

Please sign in to comment.