obsidian-releases README

The project's README from github.com/obsidianmd/obsidian-releases. As one markdown file: README.md.

About this repo

This repo is used for hosting public releases of Obsidian, as well as our community plugins & themes directories.

Obsidian is not open source software and this repo DOES NOT contain the source code of Obsidian. However, if you wish to contribute to Obsidian, you can easily do so with our extensive plugin system. A plugin guide can be found here: https://docs.obsidian.md

This repo does not accept issues, if you have questions or issues with plugins, please go to their own repo to file them. If you have questions or issues about core Obsidian itself, please post them to our community: https://obsidian.md/community

Submit your plugin or theme

You can find a detailed explanation for submitting your plugin here and your theme here.

Policies

All submissions must conform with our developer policies

How community plugins are pulled

Announcing the First Public Release of your Plugin/Theme

obsidian-releases (obsidianmd/obsidian-releases)

community
Searching Database…

What is this?This is the official Obsidian releases repo: it hosts public releases of the app plus the community plugins and themes directories that power the in-app plugin and theme browser.
Is Obsidian open source, then? What is actually in this repo?No — Obsidian itself is not open source, and this repo contains none of its source code. What is here is the downloadable releases plus the JSON lists that feed the community plugin and theme directories.
How do I get started with it?Grab the latest Obsidian installer from this repo's Releases page and install it like a regular desktop app. After that, plugins and themes are browsed and installed from inside Obsidian itself — nothing to build.
What if I run into a problem or want to report something?This repo accepts no issues at all. Problems with a plugin go to that plugin's own GitHub repo, and questions about core Obsidian go to the official community forum.
What actually happens when I install a community plugin?Obsidian looks the plugin up in community-plugins.json — the name, author and description fields are used for search — then downloads manifest.json, main.js and styles.css (if available) from the plugin's GitHub releases and stores them inside your vault.
What if a plugin needs a newer version of Obsidian than I run?The plugin's versions.json is consulted to find the latest release compatible with your running app, so you get an older-but-working version instead of a broken install.
Can I try plugins that are not officially listed yet?Yes. Authors can announce a working version as a public beta before officially submitting it, and the README recommends the BRAT plugin to make beta installation easy for testers.
How does a plugin or theme make it into the community directory?The developer follows the documented submission process and must conform to Obsidian's developer policies. Once admitted, Obsidian pulls the manifest.json and README.md straight from the plugin's GitHub repo, with files served from its GitHub releases.
Creator
obsidianmd
Size
347.9 MB
Stars
22.3K
Age
6y
Commits · 90 Days