khoj/docs/demos.md
sabaimran 1610d2ebd9
📝 Add a documentation base for Khoj! (#333)
* Add docs for more organized, accessible information detailing Khoj setup
* Delete duplicated files
* Add a coverpage without enabling it. Add logo and theme
* Remove obsidian README.md
* Add plausible script to index.html via docsify
2023-07-20 22:34:25 -07:00

1.8 KiB

Demos

Interfaces

Khoj in Obsidian

KhojObsidian

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

KhojEmacs

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