tanner/obsidian-tannersearch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Simon Cambier
2022-10-01 11:42:54 +02:00
parent 520669919c
commit 7dc01ecc8f
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -16,8 +16,9 @@ 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) - 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 - 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 - Can search other plaintext files and PDFs (configurable in settings)
- Workflow similar to "Quick Switcher" plugins - Workflow similar to "Quick Switcher" plugins
- Keyboard first: you never have to use your mouse
- Resistance to typos - Resistance to typos
- Switch between Vault and In-file search to quickly skim multiple results in a single note - Switch between Vault and In-file search to quickly skim multiple results in a single note
- Supports `"expressions in quotes"` and `-exclusions` - Supports `"expressions in quotes"` and `-exclusions`
@@ -101,6 +102,8 @@ There are several CSS classes you can use to customize the appearance of Omnisea
.omnisearch-result__counter .omnisearch-result__counter
.omnisearch-result__body .omnisearch-result__body
.omnisearch-highlight .omnisearch-highlight
.omnisearch-input-container
.omnisearch-input-field
``` ```
For example, if you'd like the usual yellow highlight on search matches, you can add this code inside a CSS snippet file: For example, if you'd like the usual yellow highlight on search matches, you can add this code inside a CSS snippet file:
@@ -112,6 +115,7 @@ For example, if you'd like the usual yellow highlight on search matches, you can
} }
``` ```
See [styles.css](./assets/styles.css) for more information.
## LICENSE ## LICENSE