Squashed commit of the following:
commit 739f9c349031510e8ef010ba2445a2a1fdbec247 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Sun Oct 16 16:57:03 2022 +0200 Code cleaning + README commit 85762bae592f3eafd34ba22b0cf1841bfbd91ca6 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Sun Oct 16 14:59:01 2022 +0200 Cleaning deleted PDFs from cache commit 1a37bf38d3f64870d4b40df1b67d8106c893ab64 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Sun Oct 16 13:18:06 2022 +0200 PDF cache saved to IndexedDB
This commit is contained in:
33
README.md
33
README.md
@@ -16,7 +16,7 @@ Under the hood, it uses the excellent [MiniSearch](https://github.com/lucaong/mi
|
||||
|
||||
- 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
|
||||
- Can search other plaintext files (configurable in settings)
|
||||
- Can search other plaintext files and PDFs (configurable in settings)
|
||||
- Workflow similar to "Quick Switcher" plugins
|
||||
- Keyboard first: you never have to use your mouse
|
||||
- Resistance to typos
|
||||
@@ -117,6 +117,37 @@ For example, if you'd like the usual yellow highlight on search matches, you can
|
||||
|
||||
See [styles.css](./assets/styles.css) for more information.
|
||||
|
||||
## Issues & Solutions
|
||||
|
||||
**Omnisearch makes Obsidian sluggish at startup.**
|
||||
|
||||
- You may have _big_ documents. Huge notes (like novels) can freeze the interface for a short time when being indexed. Enabling the setting "_Persist cache on disk_" may help you in this case.
|
||||
|
||||
**I have thousands of notes, and at startup I have to wait a few seconds before making a query, or else Omnisearch does not return all the expected results.**
|
||||
|
||||
- Enabling the setting "_Persist cache on disk_" may help you in this case.
|
||||
|
||||
**Omnisearch gives inconsistent/invalid results, or there are errors in the developer console.**
|
||||
|
||||
- Go in Omnisearch settings.
|
||||
- If applicable, disable and re-enable "*Persist cache on disk*".
|
||||
- Restart Obsidian to clear the cache and force a reindex.
|
||||
|
||||
**A query should return a result that does not appear.**
|
||||
|
||||
- If applicable, make sure that "*Ignore diacritics*" is enabled.
|
||||
- If you have modified them, reset weightings to their original values.
|
||||
- Rewrite your query and avoid numbers and common words.
|
||||
|
||||
**How do I highlight matches in search results?**
|
||||
|
||||
See [here](https://github.com/scambier/obsidian-omnisearch#css-customization).
|
||||
|
||||
**I'm still having an issue**
|
||||
|
||||
You can write your issue [here](https://github.com/scambier/obsidian-omnisearch/issues) with as much details as possible.
|
||||
|
||||
|
||||
## LICENSE
|
||||
|
||||
Omnisearch is licensed under [GPL-3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).
|
||||
|
||||
Reference in New Issue
Block a user