Halo Plugin Development

Halo is built on Spring Boot + Spring WebFlux + Vue 3. A plugin consists of:

• Backend (Java): runs inside Halo's JVM, uses Spring DI, reactive WebFlux, custom extensions (CRD-like), and custom APIs
• Frontend (Vue/TypeScript): built into main.js + style.css, injected into Console and UC (User Center)
• Manifest (plugin.yaml): plugin metadata, dependencies, settings, and config map names

Important: Halo's plugin APIs, VO field names, extension annotations, and UI APIs evolve across versions. Do not rely on training data for specific field names, method signatures, or type structures. When writing code that accesses extension fields or calls shared beans, always fetch the relevant online doc from the References section below first.

Quick Start

Create a new plugin project using the official scaffolding tool:

pnpm create halo-plugin

Follow the prompts (plugin name, domain, author, UI build tool: Rsbuild or Vite).