dive2pro / obsidian-omnisearch

A search engine that "just works" for Obsidian

Omnisearch for Obsidian

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.

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
• Resistance to typos
• In-file search to quickly skim multiple results in a single note
• Search filters: expressions in quotes and exclusions
• Respects Obsidian's "Excluded Files" list (results are downranked, not hidden)

Installation

• Omnisearch is available on the official Community Plugins repository.
• You can also install it through BRAT for pre-releases. Be advised that those versions can be buggy.

You can check the CHANGELOG for more information on the different versions.

Usage

Omnisearch can be used within 2 different contexts:

Vault Search

Omnisearch's core feature, accessible with the Command Palette "Omnisearch: Vault search". This modal searches through your vault and returns the most relevant notes first. The notes that contain the query terms in their filename or headings are weighted higher than the others.

If you need to list all the matches of a single note, you can do so by using alt+enter to open the In-File Search.

In-File Search

Also accessible through the command palette "Omnisearch: In-file search". This modal searches through the active note's content and lists the results.

Customization

There are several CSS classes you can use to customize the appearance of Omnisearch.

.omnisearch-modal
.omnisearch-result
.omnisearch-result__title
.omnisearch-result__counter
.omnisearch-result__body
.omnisearch-highlight

For example, if you'd like the usual yellow highlight on search matches, you can add this code inside a CSS snippet file:

.omnisearch-highlight {
    color: var(--text-normal);
    background-color: var(--text-highlight-bg);
}

LICENSE

Omnisearch is licensed under GPL-3.