65 lines
3.2 KiB
Markdown
65 lines
3.2 KiB
Markdown
# Locator for Obsidian
|
|
|
|
[](https://github.com/sponsors/scambier)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
**Locator** is an Obsidian plugin that lets you locate your files in a few keystrokes. It is a lightweight 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](https://github.com/lucaong/minisearch) library.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
- Locator can be installed through [BRAT](https://github.com/TfTHacker/obsidian42-brat).
|
|
|
|
You can check the [CHANGELOG](./CHANGELOG.md) 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](https://github.com/scambier/obsidian-text-extractor)
|
|
- Automatic document scoring using
|
|
the [BM25 algorithm](https://github.com/lucaong/minisearch/issues/129#issuecomment-1046257399)
|
|
- 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](https://github.com/aidenlx/cm-chs-patch) (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](https://git.scambier.xyz/scambier/obsidian-locator), 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](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).
|
|
|
|
## Thanks
|
|
|
|
To all people who donate through [Ko-Fi](https://ko-fi.com/scambier)
|
|
or [Github Sponsors](https://github.com/sponsors/scambier) ❤
|