mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 15:38:55 +01:00
Add details about the Khoj Obsidian plugin to the main Readme
- Add Khoj in Obsidian Demo - Update Interfaces Screenshot to include Obsidian Plugin Screenshot - Update .gitignore to ignore obsidian plugin ignorelist Section the .gitignore for better readability - Update the Setup, Usage instructions to include information about the Obsidian plugin
This commit is contained in:
parent
cd8b918a55
commit
0e39e0ff71
3 changed files with 55 additions and 14 deletions
33
.gitignore
vendored
33
.gitignore
vendored
|
@ -1,16 +1,37 @@
|
||||||
|
# Khoj artifacts
|
||||||
|
*.gz
|
||||||
|
*.pt
|
||||||
|
src/.data
|
||||||
|
tests/data/models
|
||||||
|
tests/data/embeddings
|
||||||
|
|
||||||
|
# External app artifacts
|
||||||
__pycache__
|
__pycache__
|
||||||
.DS_Store
|
.DS_Store
|
||||||
.emacs.desktop*
|
.emacs.desktop*
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
tests/data/models
|
|
||||||
tests/data/embeddings
|
|
||||||
src/.data
|
|
||||||
/src/interface/web/images
|
|
||||||
.vscode
|
.vscode
|
||||||
*.gz
|
|
||||||
*.pt
|
# Build artifacts
|
||||||
|
/src/interface/web/images
|
||||||
/build/
|
/build/
|
||||||
/dist/
|
/dist/
|
||||||
/khoj_assistant.egg-info/
|
/khoj_assistant.egg-info/
|
||||||
/config/khoj*.yml
|
/config/khoj*.yml
|
||||||
.pytest_cache
|
.pytest_cache
|
||||||
|
khoj.log
|
||||||
|
|
||||||
|
# Obsidian plugin artifacts
|
||||||
|
# ---
|
||||||
|
# npm
|
||||||
|
node_modules
|
||||||
|
|
||||||
|
# Don't include the compiled obsidian main.js file in the repo.
|
||||||
|
# They should be uploaded to GitHub releases instead.
|
||||||
|
main.js
|
||||||
|
|
||||||
|
# Exclude sourcemaps
|
||||||
|
*.map
|
||||||
|
|
||||||
|
# obsidian
|
||||||
|
data.json
|
||||||
|
|
36
Readme.md
36
Readme.md
|
@ -8,9 +8,9 @@
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Features](#Features)
|
- [Features](#Features)
|
||||||
- [Demo](#Demo)
|
- [Demos](#Demos)
|
||||||
- [Description](#Description)
|
- [Khoj in Obsidian](#khoj-in-obsidian)
|
||||||
- [Analysis](#Analysis)
|
- [Khoj in Emacs, Browser](#khoj-in-emacs-browser)
|
||||||
- [Interfaces](#Interfaces)
|
- [Interfaces](#Interfaces)
|
||||||
- [Architecture](#Architecture)
|
- [Architecture](#Architecture)
|
||||||
- [Setup](#Setup)
|
- [Setup](#Setup)
|
||||||
|
@ -46,11 +46,24 @@
|
||||||
- **Multiple Sources**: Search your Org-mode and Markdown notes, Beancount transactions and Photos
|
- **Multiple Sources**: Search your Org-mode and Markdown notes, Beancount transactions and Photos
|
||||||
- **Multiple Interfaces**: Search using a [Web Browser](./src/interface/web/index.html), [Emacs](./src/interface/emacs/khoj.el) or the [API](http://localhost:8000/docs)
|
- **Multiple Interfaces**: Search using a [Web Browser](./src/interface/web/index.html), [Emacs](./src/interface/emacs/khoj.el) or the [API](http://localhost:8000/docs)
|
||||||
|
|
||||||
## Demo
|
## Demos
|
||||||
|
### Khoj in Obsidian
|
||||||
|
https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8a26-b0bfc0a4344f.mp4
|
||||||
|
|
||||||
|
#### Description
|
||||||
|
|
||||||
|
- Install Khoj via `pip` and start Khoj backend in non-gui mode
|
||||||
|
- Install Khoj plugin via Community Plugins settings pane on Obsidian app
|
||||||
|
- Check the new Khoj plugin settings
|
||||||
|
- Let Khoj backend index the markdown files in the current Vault
|
||||||
|
- 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/)
|
||||||
|
- Jump to the [search result](https://marcus.se.net/obsidian-plugin-docs/publishing/submit-your-plugin)
|
||||||
|
|
||||||
|
### 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
|
#### Description
|
||||||
|
|
||||||
- Install Khoj via pip
|
- Install Khoj via pip
|
||||||
- Start Khoj app
|
- Start Khoj app
|
||||||
|
@ -58,7 +71,7 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
||||||
- 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)
|
||||||
|
|
||||||
### Analysis
|
#### Analysis
|
||||||
|
|
||||||
- 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?*
|
||||||
|
@ -74,6 +87,10 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
|
||||||
![](https://github.com/debanjum/khoj/blob/master/docs/khoj_architecture.png)
|
![](https://github.com/debanjum/khoj/blob/master/docs/khoj_architecture.png)
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
These are the general setup instructions for Khoj.
|
||||||
|
|
||||||
|
Check the [Khoj Obsidian Readme]((https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with the Obsidian Plugin. Its simpler as it can skip the configure step below.
|
||||||
|
|
||||||
### 1. Install
|
### 1. Install
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
@ -94,11 +111,14 @@ khoj
|
||||||
## Use
|
## Use
|
||||||
### Interfaces
|
### Interfaces
|
||||||
|
|
||||||
- **Khoj via Web**
|
- **Khoj via Obsidian**
|
||||||
- Open <http://localhost:8000/> via desktop interface or directly
|
- [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)
|
||||||
- **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>`
|
||||||
|
- **Khoj via Web**
|
||||||
|
- Open <http://localhost:8000/> via desktop interface or directly
|
||||||
- **Khoj via API**
|
- **Khoj via API**
|
||||||
- See the Khoj FastAPI [Swagger Docs](http://localhost:8000/docs), [ReDocs](http://localhost:8000/redocs)
|
- See the Khoj FastAPI [Swagger Docs](http://localhost:8000/docs), [ReDocs](http://localhost:8000/redocs)
|
||||||
|
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 606 KiB After Width: | Height: | Size: 994 KiB |
Loading…
Reference in a new issue