https://github.com/halo-dev/plugin-starter

Halo 2.0 插件开发快速开始模板
https://github.com/halo-dev/plugin-starter

halo halo-plugin halo-plugin-starter

Last synced: about 1 month ago
JSON representation

Halo 2.0 插件开发快速开始模板

• Host: GitHub
• URL: https://github.com/halo-dev/plugin-starter
• Owner: halo-dev
• License: gpl-3.0
• Created: 2022-06-08T08:04:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-06T05:04:30.000Z (4 months ago)
• Last Synced: 2024-08-06T07:20:52.100Z (4 months ago)
• Topics: halo, halo-plugin, halo-plugin-starter
• Language: Vue
• Homepage:
• Size: 5.99 MB
• Stars: 41
• Watchers: 3
• Forks: 53
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-halo - plugin-starter - Halo 2.0 的插件快速开始脚手架 (Halo 2.0 / 插件)

README

        
# plugin-starter

Halo 2.0 插件开发快速开始模板。

## 开发环境

插件开发的详细文档请查阅：

所需环境：

1. Java 17

2. Node 20

3. pnpm 9

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 容器并加载当前的插件，更多文档可查阅：

### 运行方式 2

> 此方式需要使用源码运行 Halo

编译插件：

```bash

# macOS / Linux

./gradlew build

# Windows

./gradlew.bat build

```

修改 Halo 配置文件：

```yaml

halo:

  plugin:

    runtime-mode: development

    fixedPluginPath:

      - "/path/to/plugin-starter"

```

最后重启 Halo 项目即可。