Build a Voiden Plugin
Ready to extend Voiden with your own features? The plugin system gives you access to slash commands, custom editor blocks, sidebar panels, request pipeline hooks, and much more.
Start here and follow the guides below to go from zero to a working plugin.
Guides
| Guide | Description |
|---|---|
| Overview | Understand the plugin architecture, what plugins can do, and what you'll need |
| Getting Started | Build your first plugin step by step — from project setup to testing locally |
| Plugin API Reference | Full reference for every method on the PluginContext object |
| Manifest Reference | Complete schema for the manifest.json file |
Quick Start
If you just want to get going fast:
# 1. Create and initialize the project
mkdir my-voiden-plugin && cd my-voiden-plugin
npm init -y
# 2. Install dependencies
npm install @voiden/sdk
npm install --save-dev typescript esbuild @types/react
# 3. Create your plugin files (see Getting Started guide)
# 4. Build and package as a ZIP
npm run build
cd dist && zip -r ../my-voiden-plugin.zip manifest.json main.js && cd ..
# 5. Install in Voiden: Extension Browser → "Install from file" → select the ZIP
Head over to Getting Started for the full walkthrough.