Submission requirements for plugins

This page lists extends the Developer policies with plugin-specific requirements that all plugins must follow to be published.

Only use fundingUrl to link to services for financial support

Use fundingUrl if you accept financial support for your plugin, using services like Buy Me A Coffee or GitHub Sponsors.

If you don't accept donations, remove fundingUrl from your manifest.

Set an appropriate minAppVersion

The minAppVersion in the Manifest should be set to the minimum required version of the Obsidian app that your plugin is compatible with.
If you don't know what an appropriate version number is, use the latest stable build number.

Keep plugin descriptions short and simple

Good plugin descriptions help users understand your plugin quickly and succinctly. Good descriptions often start with an action statement such as:

  • "Translate selected text into..."
  • "Generate notes automatically from..."
  • "Import notes from..."
  • "Sync highlights and annotations from..."
  • "Open links in..."

Avoid starting your description with "This is a plugin", because it'll be obvious to users in the context of the Community Plugins directory.

Submission requirements for plugins
Interactive graph