mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-08 05:39:13 +00:00
Fold Demo video descriptions, analysis by default in main Readme
This commit is contained in:
12
Readme.md
12
Readme.md
@@ -53,7 +53,7 @@
|
|||||||
### Khoj in Obsidian
|
### Khoj in Obsidian
|
||||||
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>
|
||||||
|
|
||||||
- Install Khoj via `pip` and start Khoj backend in non-gui mode
|
- Install Khoj via `pip` and start Khoj backend in non-gui mode
|
||||||
- Install Khoj plugin via Community Plugins settings pane on Obsidian app
|
- Install Khoj plugin via Community Plugins settings pane on Obsidian app
|
||||||
@@ -62,24 +62,27 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8
|
|||||||
- Open Khoj plugin on Obsidian via Search button on Left Pane
|
- Open Khoj plugin on Obsidian via Search button on Left Pane
|
||||||
- Search \"*Announce plugin to folks*\" in the [Obsidian Plugin docs](https://marcus.se.net/obsidian-plugin-docs/)
|
- Search \"*Announce plugin to folks*\" in the [Obsidian Plugin docs](https://marcus.se.net/obsidian-plugin-docs/)
|
||||||
- Jump to the [search result](https://marcus.se.net/obsidian-plugin-docs/publishing/submit-your-plugin)
|
- Jump to the [search result](https://marcus.se.net/obsidian-plugin-docs/publishing/submit-your-plugin)
|
||||||
|
</details>
|
||||||
|
|
||||||
### Khoj in Emacs, Browser
|
### Khoj in Emacs, Browser
|
||||||
https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9087-a1ea194b8f4b.mp4
|
https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9087-a1ea194b8f4b.mp4
|
||||||
|
|
||||||
#### Description
|
<details><summary>Description</summary>
|
||||||
|
|
||||||
- Install Khoj via pip
|
- Install Khoj via pip
|
||||||
- Start Khoj app
|
- Start Khoj app
|
||||||
- Add this readme and [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs) as org-mode for Khoj to index
|
- Add this readme and [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs) as org-mode for Khoj to index
|
||||||
- Search \"*Setup editor*\" on the Web and Emacs. Re-rank the results for better accuracy
|
- Search \"*Setup editor*\" on the Web and Emacs. Re-rank the results for better accuracy
|
||||||
- Top result is what we are looking for, the [section to Install Khoj.el on Emacs](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation)
|
- Top result is what we are looking for, the [section to Install Khoj.el on Emacs](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation)
|
||||||
|
</details>
|
||||||
|
|
||||||
#### Analysis
|
<details><summary>Analysis</summary>
|
||||||
|
|
||||||
- The results do not have any words used in the query
|
- The results do not have any words used in the query
|
||||||
- *Based on the top result it seems the re-ranking model understands that Emacs is an editor?*
|
- *Based on the top result it seems the re-ranking model understands that Emacs is an editor?*
|
||||||
- The results incrementally update as the query is entered
|
- The results incrementally update as the query is entered
|
||||||
- The results are re-ranked, for better accuracy, once user hits enter
|
- The results are re-ranked, for better accuracy, once user hits enter
|
||||||
|
</details>
|
||||||
|
|
||||||
### Interfaces
|
### Interfaces
|
||||||
|
|
||||||
@@ -116,7 +119,7 @@ khoj
|
|||||||
|
|
||||||
- **Khoj via Obsidian**
|
- **Khoj via Obsidian**
|
||||||
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) the Khoj Obsidian plugin
|
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) the Khoj Obsidian plugin
|
||||||
- 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)
|
||||||
- **Khoj via Emacs**
|
- **Khoj via Emacs**
|
||||||
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation) [khoj.el](./src/interface/emacs/khoj.el)
|
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation) [khoj.el](./src/interface/emacs/khoj.el)
|
||||||
- Run `M-x khoj <user-query>`
|
- Run `M-x khoj <user-query>`
|
||||||
@@ -152,7 +155,6 @@ pip install --upgrade khoj-assistant
|
|||||||
|
|
||||||
### Upgrade Khoj on Emacs
|
### Upgrade Khoj on Emacs
|
||||||
- Use your Emacs Package Manager to Upgrade
|
- Use your Emacs Package Manager to Upgrade
|
||||||
- E.g Run `M-x package-refresh-content` followed by `M-x package-reinstall khoj` to upgrade `khoj.el`
|
|
||||||
- See [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade) for details
|
- See [khoj.el readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade) for details
|
||||||
|
|
||||||
### Upgrade Khoj on Obsidian
|
### Upgrade Khoj on Obsidian
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ pip install khoj-assistant && khoj --no-gui
|
|||||||
See [official docs](https://help.obsidian.md/Advanced+topics/Community+plugins#Discover+and+install+community+plugins) for details
|
See [official docs](https://help.obsidian.md/Advanced+topics/Community+plugins#Discover+and+install+community+plugins) for details
|
||||||
|
|
||||||
## 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
|
### Query Filters
|
||||||
Use structured query syntax to filter the natural language search results
|
Use structured query syntax to filter the natural language search results
|
||||||
|
|||||||
Reference in New Issue
Block a user