30 lines
1.7 KiB
Markdown
30 lines
1.7 KiB
Markdown
**Omnisearch** is a search engine that "_just works_". It always instantly shows you the most relevant results, thanks to its smart weighting algorithm.
|
|
|
|
## Installation
|
|
|
|
- Omnisearch is available on [the official Community Plugins repository](https://obsidian.md/plugins?search=Omnisearch).
|
|
- Beta releases can be installed through [BRAT](https://github.com/TfTHacker/obsidian42-brat). **Be advised that those versions can be buggy and break things.**
|
|
|
|
> [!INFO] Chinese users
|
|
> If you have notes in Chinese, you should install [this additional plugin](https://github.com/aidenlx/cm-chs-patch) for better search results.
|
|
|
|
## Documentation
|
|
|
|
- [[How to use Omnisearch]]
|
|
- [[Images, PDFs, and non-text documents]]
|
|
- [[Public API & URL Scheme]]
|
|
- [[Inject Omnisearch results into your search engine]]
|
|
- [[Issues & Solutions]]
|
|
|
|
## LICENSE
|
|
|
|
Omnisearch is licensed under [GPL-3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)). You're welcome to fork it and use its code in your own project, but you must disclose your code and publish it under the same terms.
|
|
|
|
## Thanks
|
|
|
|
❤ To all people who donate through [Ko-Fi](https://ko-fi.com/scambier) or [Github Sponsors](https://github.com/sponsors/scambier), to code contributors, and to the Obsidian team who graciously provides this Publish space ❤
|
|
|
|
If you wish to get involved in Omnisearch's development, there are [open issues](https://github.com/scambier/obsidian-omnisearch/issues) that need to be solved, and probably several of them tagged as "[good first issue](https://github.com/scambier/obsidian-omnisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)" :)
|
|
|
|
|
|
 |