Upgrade Khoj.el Readme. Add TOC, Screenshot, Features Sections

- Update Query filter details
This commit is contained in:
Debanjum Singh Solanky
2023-01-12 01:17:52 -03:00
parent 2fe21f3a78
commit e6793816f9
4 changed files with 50 additions and 20 deletions

View File

@@ -75,7 +75,7 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
- 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/master/src/interface/emacs/#2-install-khojel)
</details> </details>
<details><summary>Analysis</summary> <details><summary>Analysis</summary>
@@ -97,7 +97,9 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9
## Setup ## Setup
These are the general setup instructions for Khoj. 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. - Check the [Khoj.el Readme](https://github.com/debanjum/khoj/master/src/interface/emacs#Setup) to setup Khoj with Emacs
- Check the [Khoj Obsidian Readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with the Obsidian Plugin<br />
Its simpler as it can skip the configure step below.
### 1. Install ### 1. Install

BIN
docs/khoj_on_emacs.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

@@ -1,12 +1,34 @@
* Emacs Khoj * Khoj Emacs 🦅
[[https://stable.melpa.org/#/khoj][file:https://stable.melpa.org/packages/khoj-badge.svg]] [[https://melpa.org/#/khoj][file:https://melpa.org/packages/khoj-badge.svg]] [[https://stable.melpa.org/#/khoj][file:https://stable.melpa.org/packages/khoj-badge.svg]] [[https://melpa.org/#/khoj][file:https://melpa.org/packages/khoj-badge.svg]]
/The Emacs interface for [[https://github.com/debanjum/khoj][Khoj]]/ /Natural language search from within Emacs using [[https://github.com/debanjum/khoj][Khoj]]/
** Prerequisites ** Table of Contents
- Install and Run [[https://github.com/debanjum/khoj][Khoj]] - [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#features][Features]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Interface][Interface]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup][Setup]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#1-Setup-Backend][Setup Backend]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#2-Install-Khojel][Install Khoj.el]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Use][Use]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade][Upgrade]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade-Khoj-Backend][Upgrade Backend]]
- [[https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Upgrade-Khojel][Upgrade Khoj.el]]
** Installation ** Features
- *Natural*: Advanced natural language understanding using Transformer based ML Models
- *Local*: Your personal data stays local. All search, indexing is done on your machine*
- *Incremental*: Incremental search for a fast, search-as-you-type experience
** Interface
[[/docs/khoj_on_emacs.png]]
** Setup
*** 1. Setup Backend
#+begin_src shell
pip install khoj-assistant && khoj
#+end_src
*** 2. Install Khoj.el
**** Using MELPA **** Using MELPA
#+begin_src elisp #+begin_src elisp
M-x package-install khoj M-x package-install khoj
@@ -36,7 +58,7 @@
:bind ("C-c s" . 'khoj)) :bind ("C-c s" . 'khoj))
#+end_src #+end_src
** Usage ** Use
1. Open Query Interface on Client 1. Open Query Interface on Client
- In Emacs: Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~ - In Emacs: Call ~khoj~ using keybinding ~C-c s~ or ~M-x khoj~
@@ -46,23 +68,29 @@
e.g "What is the meaning of life?" "What are my life goals?" e.g "What is the meaning of life?" "What are my life goals?"
3. Apply filters to narrow down results further 3. Apply filters to narrow down results further. See [[https://github.com/debanjum/khoj/#query-filters][query filters]] for details
Include/Exclude specific words or date range from results by updating query with below query format Include/Exclude specific words or date range from results by updating query with below query format
e.g `What is the meaning of life? -god +none dt:"last week"` e.g `What is the meaning of life? -"god" +"none" dt>"last week"`
** Upgrade ** Upgrade
Use your Emacs package manager to upgrade `khoj.el` *** Upgrade Khoj Backend
#+begin_src shell
pip install --upgrade khoj-assistant
#+end_src
- For `khoj.el` from MELPA *** Upgrade Khoj.el
Use your Emacs package manager to upgrade ~khoj.el~
- For ~khoj.el~ from MELPA
- Method 1 - Method 1
- Run `M-x package-list-packages` to list all packages - Run ~M-x package-list-packages~ to list all packages
- Press `U` on `khoj` to mark it for upgrade - Press ~U~ on ~khoj~ to mark it for upgrade
- Press `x` to execute the marked actions - Press ~x~ to execute the marked actions
- Method 2 - Method 2
- Run `M-x package-refresh-content` - Run ~M-x package-refresh-content~
- Run `M-x package-reinstall khoj` - Run ~M-x package-reinstall khoj~
- For `khoj.el` from Straight - For ~khoj.el~ from Straight
- Run `M-x straight-pull-package khoj` - Run ~M-x straight-pull-package khoj~

View File

@@ -47,7 +47,7 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8
```shell ```shell
pip install khoj-assistant && khoj --no-gui pip install khoj-assistant && khoj --no-gui
``` ```
## 2. Setup Plugin ### 2. Setup Plugin
1. Open *Community plugins* tab in Obsidian settings panel 1. Open *Community plugins* tab in Obsidian settings panel
2. Click Browse and Search for *Khoj* 2. Click Browse and Search for *Khoj*
3. Click *Install*, after that click *Enable* on the Khoj plugin 3. Click *Install*, after that click *Enable* on the Khoj plugin