If you want to share your plugin with the Obsidian community, the best way is to submit it to the official list of plugins. Once we've reviewed and published your plugin, users can install it directly from within Obsidian. It'll also be featured in the plugin directory on the Obsidian website.

You only need to submit the initial version of your plugin. After your plugin has been published, users can download new releases from GitHub directly from within Obsidian.

Prerequisites

To complete this guide, you'll need:

Before you begin

Before you submit your plugin, make sure you have the following files in the root folder of your repository:

  • A README.md that describes the purpose of the plugin, and how to use it.
  • A LICENSE that determines how others are allowed to use the plugin and its source code. If you need help to add a license for your plugin, refer to Choose a License.
  • A manifest.json that describes your plugin. For more information, refer to Manifest.

Step 1: Publish your plugin to GitHub

Template repositories

If you created your plugin from one of our template repositories, you may skip this step.

Submit your plugin
Interactive graph