DOCSEARCHbyAlgolia
Submit Docs

Obsidian Community Releases and Plugin Registry

repository·master·Indexed 12 days ago

https://github.com/obsidianmd/obsidian-releases

Documentation for the Obsidian ecosystem registry, covering the submission and discovery process for community plugins and themes. Includes details on how Obsidian pulls plugins via community-plugins.json, version checking using manifest.json and versions.json, and the required file structure for GitHub repositories.

Tokens
684
Snippets
0
Records
3
Agent score
48%

What's inside Obsidian

  1. How Obsidian pulls community plugins

    master

    Obsidian uses a specific mechanism to discover and install community plugins from GitHub. Understanding this lifecycle is critical for developers ensuring their plugins are discoverable and installable:

    1. Discovery: Obsidian reads community-plugins.json in this repository. It uses the name, author, and description fields for search functionality.
    2. Metadata Fetching: When a user views a plugin's detail page, Obsidian fetches the manifest.json and README.md directly from your GitHub repository.
    3. Version Checking: The manifest.json in your repo is used to determine the latest version. If your manifest.json requires an Obsidian version higher than the user's current app version, Obsidian consults versions.json in this repo to find the latest compatible version of your plugin.
    4. Installation: When a user clicks install, Obsidian looks for GitHub releases tagged identically to the version specified in your manifest.json.
    5. File Download: Obsidian downloads manifest.json, main.js, and styles.css (if present) from your GitHub releases and stores them in the user's vault.

    Required Files in your GitHub Repo:

    • manifest.json (defines version and requirements)
    • main.js (the plugin logic)
    • README.md (plugin description)
    • styles.css (optional, for plugin styling)

  3. Announce your plugin or theme release

    master

    After your plugin or theme has been admitted to the community, you can announce it through the following channels:

    Beta Testing Tip: If you want to test a working version before official submission, you can release it as a public beta. It is highly recommended to suggest that beta testers use the BRAT Plugin to simplify the installation process for non-official releases.