@apivexa/plugins

Plugin system for ApiVexa — register custom AI providers, renderers, output targets, languages, inputs, and agent adapters.

Part of ApiVexa — AI-powered API User Guide Generator.

Install

npm install @apivexa/plugins

Extension points

| Plugin type | Interface | What it adds | |-------------|-----------|--------------| | AiProviderPlugin | Custom model backends | New AI providers | | RendererPlugin | Custom output formats | New renderers | | OutputPlugin | Custom destinations | File, S3, stdout, … | | LanguagePlugin | Custom code example langs | New programming languages | | InputPlugin | Custom spec sources | Git, S3, databases, … | | AgentAdapterPlugin | Cross-agent integration | Claude Code, Cursor, … |

Usage

import { PluginRegistry, createDefaultRegistry } from '@apivexa/plugins';

// Start with all built-in plugins
const registry = createDefaultRegistry();

// Register a custom renderer
registry.register({
  type: 'renderer',
  name: 'rst',
  renderToMarkdown: (doc) => myRstRenderer(doc),
});

// List registered plugins
console.log(registry.list('renderer'));
// ['markdown', 'html', 'rst']

Built-in plugins

• AI providers: anthropic, openai-compatible
• Renderers: markdown, html
• Outputs: file, stdout
• Agent adapters: claude-code, cursor, copilot, cline

Full documentation