Skip to main content

Getting started

ONLYOFFICE supports three ways to extend editor functionality: plugins, macros, and custom AI tools. This page helps you choose the right approach and get started.

If you prefer to start coding right away, go directly to the quick start guides or try things out in the interactive playground.

What you can build​

Plugins — interactive tools with rich UI​

Build sophisticated integrations that feel native to ONLYOFFICE.

Perfect for:

  • Embedding external content (YouTube, media galleries)
  • Third-party integrations (Translator, Zotero, CRM systems)
  • Advanced processing (OCR, image manipulation, data visualization)
  • Custom workflows (form builders, approval systems, templates)

Development profile:

  • Time: 2-7 days | Skill: Intermediate | Tech: HTML/CSS/JavaScript
  • Distribution: ONLYOFFICE Marketplace or private deployment

Browse live examples in ONLYOFFICE Marketplace

Macros — instant automation scripts​

Lightweight JavaScript that runs directly in documents — no installation needed.

Perfect for:

Development profile:

  • Time: 30 mins - 2 hours | Skill: Beginner | Tech: JavaScript basics
  • Distribution: Copy-paste code or embed in document templates

Browse all macro examples

Custom AI tools — intelligent assistants​

Custom tools enhanced with AI capabilities for next-generation document workflows.

Perfect for:

Development profile:

  • Time: 3-10 days | Skill: Advanced | Tech: Plugin API + AI provider integration
  • Requirements: API keys for OpenAI, Claude, or custom AI services

Browse all AI function examples

Which approach would you choose?​

Answer these questions to find your ideal path:

ONLYOFFICE API Scheme ONLYOFFICE API Scheme

Detailed comparison​

FeaturePluginsMacrosAI plugins
What is it?HTML/CSS/JS app embedded in editorJavaScript code in documentsPlugin + AI provider integration
InstallationRequired (marketplace or manual)None (embedded in docs)Required (like plugins)
User interface✅ Full custom UI❌ No UI✅ Full custom UI
External APIs✅ Yes (REST, GraphQL, etc.)❌ No✅ Yes (AI services required)
Offline use⚠️ Depends on features✅ Fully offline❌ Requires internet
Skill levelIntermediateBeginnerAdvanced
Dev time2-7 days30 mins - 2 hours3-10 days
DistributionMarketplace, GitHub, privateCopy-paste, templatesMarketplace, private
Best forReusable tools, integrationsPersonal automationAI-powered features
Framework support✅ React, Vue, Angular❌ Vanilla JS only✅ Any framework

Troubleshooting​

Plugin issues​

Plugin doesn't appear:

  • Check config.json has a unique GUID
  • Verify file paths are correct
  • Restart ONLYOFFICE

JavaScript errors:

  • Open browser DevTools (F12)
  • Check the Console tab for error messages
  • Verify plugin.js is loaded

API methods fail:

  • Ensure your ONLYOFFICE version supports the method
  • Check method syntax in the API reference
  • Verify editor type compatibility

Macro issues​

Macro doesn't run:

  • Check macros are enabled in Tools → Settings
  • Look for syntax errors in the macro editor
  • Verify API method names are correct

Unexpected results:

  • Add console.log() statements for debugging
  • Test each step individually
  • Check document state before running

Need more help?

Resources​

Development tools​

Sample code​

Documentation​

Community​

Next steps​

Start building:

Experiment:

Learn more: