Plugin Development

Readied supports a plugin system that lets you extend the editor with custom functionality. Plugins can add commands, UI components, editor extensions, and more.

Quick Start

npx readied-plugin init "My Plugin"
cd my-plugin
npm install

import type { PluginManifest } from '@readied/plugin-api';

export const plugin: PluginManifest = {
  id: 'my-plugin',
  name: 'My Plugin',
  version: '0.1.0',
  description: 'Does something useful',

  activate(context) {
    // Register a command in the command palette
    const unregister = context.registerCommand(
      {
        id: 'hello',
        name: 'Say Hello',
        icon: 'Smile',
      },
      () => {
        context.log.info('Hello from My Plugin!');
        return true;
      }
    );

    // Clean up when the plugin is deactivated
    return {
      dispose() {
        unregister();
      },
    };
  },
};

npm run build

cp -r dist/ ~/Library/Application\ Support/Readied/plugins/my-plugin/

xcopy /E dist\ %APPDATA%\Readied\plugins\my-plugin\

cp -r dist/ ~/.config/Readied/plugins/my-plugin/

Plugin Contract

1. Removable without breaking .md files — Your plugin can be uninstalled and all notes remain valid markdown.
2. No new syntax — Don't invent markdown extensions that other editors can't read.
3. No automatic content mutation — Never modify the user's markdown without explicit action.
4. Not required to interpret text — Notes must be readable without your plugin.
5. No inter-note dependencies — Don't create relationships that break if notes are moved or deleted.

Plugin Lifecycle

load → activate(context) → [user interacts] → dispose()

1. Load — Readied discovers your plugin and reads manifest.json
2. Activate — Your activate() function receives a PluginContext with the full API
3. Running — Your plugin responds to commands, events, and editor changes
4. Dispose — When disabled or on app exit, your dispose() function cleans up

Next Steps