Skip to content

Commit

Permalink
Add Screenshots of Khoj Chat Interface on Emacs, Obsidian to Readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
debanjum committed Apr 7, 2023
1 parent 35aa060 commit 453c84a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
Binary file added docs/khoj_chat_on_emacs_0.5.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions src/interface/emacs/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,12 @@
- *Assisted creativity*: Smoothly weave across answer retrieval and content generation

** Interface
*** Search UI
[[/docs/khoj_on_emacs.png]]

*** Chat UI
[[/docs/khoj_chat_on_emacs_0.5.0.png]]

** Setup
- /Make sure [[https://realpython.com/installing-python/][python]] (version 3.10 or lower) and [[https://pip.pypa.io/en/stable/installation/][pip]] are installed on your machine/

Expand Down
13 changes: 10 additions & 3 deletions src/interface/obsidian/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@

- [Features](#Features)
- [Demo](#Demo)
- [Description](#Description)
- [Interface](#Interface)
- [Search Demo](#Search-Demo)
- [Interfaces](#Interfaces)
- [Search Modal](#Search-Modal)
- [Chat Modal](#Chat-Modal)
- [Setup](#Setup)
- [Setup Backend](#1-Setup-Backend)
- [Setup Plugin](#2-Setup-Plugin)
Expand All @@ -32,6 +34,7 @@
- **Assisted creativity**: Smoothly weave across answers retrieval and content generation

## Demo
### Search Demo
https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8a26-b0bfc0a4344f.mp4

<details><summary>Description</summary>
Expand All @@ -46,9 +49,13 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8

</details>

### Interface
## Interfaces
### Search Modal
![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_on_obsidian_0.2.5.png?)

### Chat Modal
![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_chat_on_obsidian_0.6.0.png?)

## Setup
- *Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine*
- *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*
Expand Down

0 comments on commit 453c84a

Please sign in to comment.