For Developers
As a developer, you can extend Revela with your own plugins and themes, script it in CI, or help build Revela itself. This page points you to the right place. Contributor documentation lives next to the code on GitHub, so it stays current with every change.
Build on Revela
🧩 Plugin Development →Implement
IPlugin, register services, add CLI commands, test and package your plugin.
📦 SDK →Spectara.Revela.Sdk: the public interfaces for plugins and themes. The package is attached to every GitHub Release.
🎨 Theme Authoring →Build a theme or change one deeply with Scriban templates: required partials, image helpers, UI text and extensions.
🧰 Template Functions →Every function and variable available in templates.
Automate Revela
Every menu entry is also a command, so Revela runs unattended in scripts and CI pipelines. Start with the CLI Reference and the Configuration guide (settings can also come from environment variables). The Deployment guide includes a GitHub Actions example.
Understand and contribute
| Document | What's inside |
|---|---|
| Architecture | How Revela is structured, what is built in and what is a plugin |
| Project Structure | Repository layout and build configuration |
| Setup | Prerequisites, clone, build and IDE setup |
| Development Guide | Day-to-day workflow: tests, formatting, running samples |
| Security Model | Threat model and security defaults |
| AGENTS.md | Conventions for AI coding assistants working on the repo |
Bug reports, ideas and pull requests are always welcome. See you in the repo! 👋