Developers

Build plugins and extend tibok

tibok has a plugin system that allows you to extend functionality, create custom themes, and integrate with your favorite tools. The plugin system is open source and licensed under MIT.

Plugin System

Plugins can register slash commands (inline editor commands) and command palette actions. The current stable API (v1.0) provides:

  • Slash command registration for inline editor commands
  • Command palette integration for keyboard-driven workflows
  • Read-only access to app state (active document, workspace, Git status)
  • Plugin lifecycle management (discovery, initialization, deactivation)

Repositories

Main App

github.com/sturdy-barnacle/md-editor

Core application source code (proprietary non-commercial license)

Plugin SDK

coming soon

Plugin SDK and API reference (MIT License)

Community Plugins

coming soon

Official and community-contributed plugins

Getting Started

To build plugins for tibok:

  1. Clone the Plugin SDK repository (TBD)
  2. Review the API specification and plugin protocol
  3. Implement the TibokPlugin protocol
  4. Register slash commands and command palette actions
  5. Test your plugin in tibok's development mode

The plugin system uses Swift protocols and runs on the main actor. All plugins must implement the TibokPlugin protocol and register their contributions through the PluginContext.

Documentation

Full API documentation and examples are available in the Plugin SDK repository (TBD). The API is stable as of v1.0. We intend to maintain backward compatibility within the v1.x release series, following semantic versioning principles.

For questions or support, check the GitHub repositories or contact k@emberwisp.xyz.