README file from
GithubStore
Manage your notes within a single folder. Almost.

Usage
[!WARNING] Though the plugin should be safe to the data, it's almost impossible to revert the changes to the vault's structure made by this plugin. You should make a backup of the vault before the first use.
It's recommended to read the documentation before installing the plugin. It's hard to describe in a few words why this plugin is even needed and what it does, so a separate usage "book" is needed.
See docs.
Versioning
This plugin follows Semantic Versioning.
- Each major version signifies a breaking change in settings format, so a manual intervention can be needed after an update;
- Each minor version signifies a new feature;
- Each patch signifies a fix.
While the major version is zero, each minor version bump is a breaking change instead, and each patch is a new feature.
Installation
Community plugins
This plugin is available to install from Community tab.
- Visit Community site and click "Add to Obsidian" to search this plugin inside of the app.
- Just search for the plugin manually in Community plugins after disabling restricted mode.
- Copy this link and open it in your browser:
obsidian://show-plugin?id=store.
GitHub releases
This repository has automatic GitHub releases, so you can manually install the
plugin in vault/.obsidian/plugins/store by copying main.js and
manifest.json there.
Nix
This repository is a Nix flake and contains a package for the plugin. You can either:
- Use package for
obsidianmodule in home-manager. - Manually install the package contents in
vault/.obsidian/plugins/store.
Contributing
See Contributing.
License
Unless otherwise noted, the source files are distributed under the BSD-3-Clause license.