mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-09 21:29:11 +00:00
Update Obsidian Plugin Readme. Add Khoj icon to Khoj Modal Placeholder text
- Fold Query Filter, Demo Description - Add Limitations to Readme - Add *Update* index bullet to Troubleshooting Options
This commit is contained in:
@@ -26,15 +26,18 @@
|
|||||||
## Demo
|
## Demo
|
||||||
https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8a26-b0bfc0a4344f.mp4
|
https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8a26-b0bfc0a4344f.mp4
|
||||||
|
|
||||||
### Description
|
<details><summary>Description</summary>
|
||||||
|
|
||||||
1. Install Khoj via `pip` and start Khoj backend in non-gui mode
|
1. Install Khoj via `pip` and start Khoj backend in non-gui mode
|
||||||
2. Install Khoj plugin via Community Plugins settings pane on Obsidian app
|
2. Install Khoj plugin via Community Plugins settings pane on Obsidian app
|
||||||
3. Check the new Khoj plugin settings
|
3. Check the new Khoj plugin settings
|
||||||
4. Let Khoj backend index the markdown files in the current Vault
|
4. Wait for Khoj backend to index markdown files in the current Vault
|
||||||
5. Open Khoj plugin on Obsidian via Search button on Left Pane
|
5. Open Khoj plugin on Obsidian via Search button on Left Pane
|
||||||
6. Search \"*Announce plugin to folks*\" in the [Obsidian Plugin docs](https://marcus.se.net/obsidian-plugin-docs/)
|
6. Search \"*Announce plugin to folks*\" in the [Obsidian Plugin docs](https://marcus.se.net/obsidian-plugin-docs/)
|
||||||
7. Jump to the [search result](https://marcus.se.net/obsidian-plugin-docs/publishing/submit-your-plugin)
|
7. Jump to the [search result](https://marcus.se.net/obsidian-plugin-docs/publishing/submit-your-plugin)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
### Interface
|
### Interface
|
||||||

|

|
||||||
|
|
||||||
@@ -54,7 +57,8 @@ See [official docs](https://help.obsidian.md/Advanced+topics/Community+plugins#D
|
|||||||
## Use
|
## Use
|
||||||
Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or Search for *Khoj: Search* in the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
|
Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or Search for *Khoj: Search* in the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
|
||||||
|
|
||||||
### Query Filters
|
<details><summary>Query Filters</summary>
|
||||||
|
|
||||||
Use structured query syntax to filter the natural language search results
|
Use structured query syntax to filter the natural language search results
|
||||||
- **Word Filter**: Get entries that include/exclude a specified term
|
- **Word Filter**: Get entries that include/exclude a specified term
|
||||||
- Entries that contain term_to_include: `+"term_to_include"`
|
- Entries that contain term_to_include: `+"term_to_include"`
|
||||||
@@ -73,6 +77,8 @@ Use structured query syntax to filter the natural language search results
|
|||||||
- excluding words *"big"* and *"brother"*
|
- excluding words *"big"* and *"brother"*
|
||||||
- that best match the natural language query *"what is the meaning of life?"*
|
- that best match the natural language query *"what is the meaning of life?"*
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
### 1. Upgrade Backend
|
### 1. Upgrade Backend
|
||||||
```shell
|
```shell
|
||||||
@@ -86,6 +92,11 @@ Use structured query syntax to filter the natural language search results
|
|||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
1. Open the Khoj plugin settings pane, in case you need to configure Khoj
|
1. Open the Khoj plugin settings pane, in case you need to configure Khoj
|
||||||
2. Toggle Enable/Disable Khoj, in case settings changes have not applied
|
2. Toggle Enable/Disable Khoj, in case settings changes have not applied
|
||||||
|
3. Click *Update* button to force index to refresh if results are failing or stale
|
||||||
|
|
||||||
|
## Current Limitations
|
||||||
|
- The plugin loads index of only one vault at a time.<br/>
|
||||||
|
So notes across multiple vaults **cannot** be search at the same time
|
||||||
|
|
||||||
## Implementation
|
## Implementation
|
||||||
The plugin implements the following functionality to search your notes with Khoj:
|
The plugin implements the following functionality to search your notes with Khoj:
|
||||||
@@ -95,4 +106,4 @@ The plugin implements the following functionality to search your notes with Khoj
|
|||||||
- Set Obsidian Vault to Index with Khoj. Defaults to all markdown files in current Vault
|
- Set Obsidian Vault to Index with Khoj. Defaults to all markdown files in current Vault
|
||||||
- Set URL of Khoj backend
|
- Set URL of Khoj backend
|
||||||
- Set Number of Search Results to show in Search Modal
|
- Set Number of Search Results to show in Search Modal
|
||||||
- [ ] Allow user to trigger reranking of result to improve search quality
|
- [X] Allow user to trigger reranking of result to improve search quality
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ export class KhojModal extends SuggestModal<SearchResult> {
|
|||||||
this.setInstructions(modalInstructions);
|
this.setInstructions(modalInstructions);
|
||||||
|
|
||||||
// Set Placeholder Text for Modal
|
// Set Placeholder Text for Modal
|
||||||
this.setPlaceholder('Search with Khoj...');
|
this.setPlaceholder('Search with Khoj 🦅...');
|
||||||
}
|
}
|
||||||
|
|
||||||
async getSuggestions(query: string): Promise<SearchResult[]> {
|
async getSuggestions(query: string): Promise<SearchResult[]> {
|
||||||
|
|||||||
Reference in New Issue
Block a user