.github/workflows | ||
assets | ||
Doc Omnisearch | ||
images | ||
src | ||
.babelrc | ||
.editorconfig | ||
.gitignore | ||
.madgerc | ||
.npmrc | ||
.prettierrc.js | ||
CHANGELOG.md | ||
cliff.toml | ||
CONTRIBUTING.md | ||
esbuild.config.mjs | ||
jest.config.js | ||
LICENSE | ||
manifest.json | ||
package.json | ||
pnpm-lock.yaml | ||
qodana.yaml | ||
README.md | ||
tsconfig.json | ||
version-bump.mjs | ||
versions.json |
Locator for Obsidian
Locator is an Obsidian plugin that lets you locate your files in a few keystrokes. It is a lightweight, experimental version of Omnisearch.
It always instantly shows you the most relevant results, thanks to its smart weighting algorithm.
Under the hood, it uses the excellent MiniSearch library.
Installation
- Locator can be installed through BRAT.
You can check the CHANGELOG for more information on the different versions.
Features
Locator's first goal is to locate files instantly. You can see it as a Quick Switcher on steroids.
- Find your 📝notes, 📄Office documents, 📄PDFs, and 🖼images faster than ever
- Images, documents, and PDF indexing is available through Text Extractor
- 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
- Keyboard first: you never have to use your mouse
- Workflow similar to the "Quick Switcher" core plugin
- Opt-in local HTTP server to query Omnisearch from outside of Obsidian
- Resistance to typos
- Supports
"expressions in quotes"
and-exclusions
- Filters file types with
.jpg
or.md
- Directly Insert a
[[link]]
from the search results - Supports Vim navigation keys
Note: support of Chinese depends on this additional plugin (also you may need to clear search cache data to apply new Chinese index). Please read its documentation for more information.
Issues & Feature Requests
If you're reading this README from the repository's page, you'll notice it is hosted on a private forge without account registration. Locator is a personal hobby project, tailored for my own needs. It is publicly available because you may find it useful too, but I'm not interested in your issues or pull requests.
Thank you for your understanding.
LICENSE
Locator is licensed under GPL-3.
Thanks
To all people who donate through Ko-Fi or Github Sponsors ❤