mirror of
https://github.com/halo-dev/plugin-starter.git
synced 2026-01-16 07:02:29 +08:00
c891124c6f
适配 https://github.com/halo-dev/halo/pull/4061 的改动。 更新 plugin.yaml 示例，添加 repo 字段。之后，homepage 和 repo 的区别如下： 1. homepage 可用于提供插件官网或者介绍页面，比如 Halo 应用市场的应用页面。 2. repo 仅作为源码仓库地址。 ```release-note None ```
plugin-starter
Halo 2.0 插件开发快速开始模板。
开发环境
插件开发的详细文档请查阅：https://docs.halo.run/developer-guide/plugin/introduction
所需环境：
- Java 17
- Node 18
- pnpm 8
- Docker (可选)
克隆项目：
git clone git@github.com:halo-sigs/plugin-starter.git
# 或者当你 fork 之后
git clone git@github.com:{your_github_id}/plugin-starter.git
cd path/to/plugin-starter
运行方式 1（推荐）
此方式需要本地安装 Docker
# macOS / Linux
./gradlew pnpmInstall
# Windows
./gradlew.bat pnpmInstall
# macOS / Linux
./gradlew haloServer
# Windows
./gradlew.bat haloServer
执行此命令后，会自动创建一个 Halo 的 Docker 容器并加载当前的插件，更多文档可查阅：https://docs.halo.run/developer-guide/plugin/basics/devtools
运行方式 2
此方式需要使用源码运行 Halo
编译插件：
# macOS / Linux
./gradlew build
# Windows
./gradlew.bat build
修改 Halo 配置文件：
halo:
plugin:
runtime-mode: development
fixedPluginPath:
- "/path/to/plugin-starter"
最后重启 Halo 项目即可。