Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
初始化说明文档
  • Loading branch information
wenjing-xin authored Jun 6, 2024
1 parent 7308044 commit ea4ea4e
Showing 1 changed file with 9 additions and 69 deletions.
78 changes: 9 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,16 @@
# plugin-starter
# plugin-multiple-content-show

Halo 2.0 插件开发快速开始模板。
为halo站点的单页面和文章集成 swiper幻灯片、PDF等文件展示功能!

## 开发环境
## 其他

插件开发的详细文档请查阅:<https://docs.halo.run/developer-guide/plugin/introduction>
... 正在开发中,如果 有什么好的建议和想法可以加入如下渠道进行交流

所需环境:
QQ交流群与QQ频道,加群后管理员自动审核
<div>
&emsp;&emsp;<img src="https://api.minio.yyds.pink/bbs/2024-06-04/1717467713-802505-qq.png" width=150px />
&emsp;&emsp;<img src="https://api.minio.yyds.pink/bbs/2024-06-04/1717467714-226493-qq.jpg" width=158px />
</div>

1. Java 17
2. Node 18
3. pnpm 8
4. Docker (可选)

克隆项目:

```bash
git clone [email protected]:halo-sigs/plugin-starter.git

# 或者当你 fork 之后

git clone [email protected]:{your_github_id}/plugin-starter.git
```

```bash
cd path/to/plugin-starter
```

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

> 此方式需要本地安装 Docker
```bash
# macOS / Linux
./gradlew pnpmInstall

# Windows
./gradlew.bat pnpmInstall
```

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

# 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 项目即可。

0 comments on commit ea4ea4e

Please sign in to comment.