/obsidian-releases

This repo is used to keep track of releases for Obsidian.

Until Silver piggybacked the community themes onto it. And also community plugins. And then snippets.

Community Plugins

To add your plugin to the list, make a pull request to the community-plugins.json file. The order of this list is not kept, please add your plugin to the end of the list.

  • id: A unique ID for your plugin. Make sure this is the same one you have in your manifest.json.
  • name: The name of your plugin. This will be used to search for your plugin.
  • author: The author's name.
  • description: A short description of what your plugin does.
  • repo: The GitHub repository identifier, in the form of user-name/repo-name, if your GitHub repo is located at https://github.com/user-name/repo-name.
  • branch: (optional) A branch if you prefer to use a specific branch of your repo. Defaults to master.

How community plugins are pulled

  • Obsidian will read the list of plugins in community-plugins.json.
  • The name field is used for searching.
  • When the user opens the detail page of your plugin, Obsidian will pull the manifest.json and README.md from your GitHub repo using the specified branch (or master).
  • The manifest.json in your repo will only be used to figure out the latest version. Actual files are fetched from your GitHub releases.
  • If your manifest.json requires a version of Obsidian that's higher than the running app, your versions.json will be consulted to find the latest version of your plugin that is compatible.
  • When the user chooses to install your plugin, Obsidian will look for your GitHub releases tagged identically to the version inside manifest.json.
  • Obsidian will download manifest.json, main.js, and styles.css (if available), and store them in the proper location inside the vault.