sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-12 16:53:01 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
khoj/documentation/docs/get-started/demos.md
sabaimran 9b991eb4fe
Migrate to using docusaurus, rather than docsify for documentation (#603) 
* Add docusaurus documentation (to replace the docsify setup
* Remove older docs
* Specify documentation as the gh pages build action working directory
2024-01-07 20:28:15 +05:30

2.2 KiB
Raw Blame History

sidebar_position
2

Demos

Check out a couple of demos and screenshots of Khoj in action.

Screenshots

Web Obsidian Emacs

Videos

Khoj in Obsidian

Link to Video

Installation
  1. Install Khoj via pip and start Khoj backend in a terminal (Run khoj) 
    python -m pip install khoj-assistant
khoj
  2. Install Khoj plugin via Community Plugins settings pane on Obsidian app
    • Check the new Khoj plugin settings
    • Let Khoj backend index the markdown, pdf, Github 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
    • Jump to the search result

Khoj in Emacs, Browser

Link to Video

Installation
  • Install Khoj via pip
  • Start Khoj app
  • Add this readme and khoj.el readme as org-mode for Khoj to index
  • 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
Analysis
  • 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?
  • The results incrementally update as the query is entered
  • The results are re-ranked, for better accuracy, once user hits enter