klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-03 21:29:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Docs to Search across Languages, Uninstall Khoj to Readme

Browse Source 
Add details and fixes to Obsidian, Main readme
based on feedback, confusion from the Obsidian plugin announcement
This commit is contained in:
Debanjum Singh Solanky
2023-02-06 19:38:20 -03:00
parent cba9a6a703
commit 66dca6cf33
2 changed files with 27 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/interface/obsidian/README.md
View File

@@ -44,8 +44,10 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8
![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_on_obsidian_0.2.5.png?)
## Setup
### 1. Setup Backend
*Note: Ensure you follow the ordering of the setup steps. Install the plugin after starting the khoj backend. This allows the plugin to configure the khoj backend.*
### 1. Setup Backend
Run below command in your terminal to install and start the khoj backend
```shell
pip install khoj-assistant && khoj --no-gui
```
@@ -59,6 +61,8 @@ See [official docs](https://help.obsidian.md/Advanced+topics/Community+plugins#D
### Search
Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Search* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
*Note: Ensure the khoj server is running in the background before searching. Execute `khoj --no-gui` in your terminal if it is not already running*
<details><summary>Query Filters</summary>
Use structured query syntax to filter the natural language search results