2.3 KiB
Omnisearch for Obsidian
This plugin is in an early beta state. It's usable, but things may break, features are missing, configuration is non-existent, etc.
If you experience what you consider to be a bug or performance problem, please open an issue.
Omnisearch is a search engine that "just works". Type what you're looking for, and it will instantly show you the most relevant results.
Under the hood, it uses the excellent MiniSearch library.
Installation & Usage
Omnisearch is not yet available on the official community plugins repository. You can either:
- Install it through BRAT
- Or download the
scambier.obsidian-omnisearch-x.y.z.zipfile from the releases page and unzip it in your.obsidian/pluginsfolder. You'll have to update it manually, though.
Once activated, you can access Omnisearch through the Command Palette by looking for "Omnisearch". You can also assign it a keybind for faster access. The Omnisearch modal works like the Quick Switch plugin: just type your query, navigate with the arrows, and open the note with Enter.
Features
- Keyboard-centric, you never have to use your mouse
- Automatic document scoring using the BM25 algorithm
- The relevance of a document against a query depends on the number of times the query terms appear in the document, its filename, and its headings
- Instant search results, with highlighting
- Fuzzy/partial search, resistance to typos
- In-file search to quickly skim multiple results in a single note
- Resistance to typos
Motivation
Obsidian works best with a well-organized vault, but most of my notes are unrelated tidbits of knowledge and code snippets, without tags, links, of even folders.
I want (need) a fast and easy way to search my notes, something that just works. That's what Omnisearch is.
Since I like to favor "search over organization", I wanted to make a search interface that would be useful for me.
LICENSE
Omnisearch is licensed under GPL-3.