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
2026-03-06 05:39:12 +00:00 · 2024-01-07 20:28:15 +05:30
parent 98081bc0d3
commit 9b991eb4fe
65 changed files with 15749 additions and 398 deletions
--- a/documentation/docs/clients/_category_.json
+++ b/documentation/docs/clients/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Clients",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Different ways for indexing data with the Khoj backend"
+  }
+}
--- a/documentation/docs/clients/desktop.md
+++ b/documentation/docs/clients/desktop.md
@@ -0,0 +1,31 @@
+---
+sidebar_position: 1
+---
+
+# Desktop
+
+Get started with using the Desktop app to index any supported files with Khoj.
+<h1><img src="/img/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo" /> Desktop</h1>
+
+> An AI copilot for your Second Brain
+
+## Features
+- **Chat**
+  - **Faster answers**: Find answers quickly, from your private notes or the public internet
+  - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+  - **Iterative discovery**: Iteratively explore and re-discover your notes
+- **Search**
+  - **Natural**: Advanced natural language understanding using Transformer based ML Models
+  - **Incremental**: Incremental search for a fast, search-as-you-type experience
+
+## Setup
+
+1. Install the [Khoj Desktop app](https://khoj.dev/downloads) for your OS
+2. Generate an API key on the [Khoj Web App](https://app.khoj.dev/config#clients)
+3. Set your Khoj API Key on the *Settings* page of the Khoj Desktop app
+4. [Optional] Add any files, folders you'd like Khoj to be aware of on the *Settings* page and Click *Save*
+
+## Interface
+| Chat | Search |
+|:----:|:------:|
+| ![](/img/khoj_chat_on_desktop.png) | ![](/img/khoj_search_on_desktop.png) |
--- a/documentation/docs/clients/emacs.md
+++ b/documentation/docs/clients/emacs.md
@@ -0,0 +1,140 @@
+---
+sidebar_position: 2
+---
+
+# Emacs
+
+Use Khoj with Emacs to search your Second Brain from within Emacs.
+
+<h1><img src="/img/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo" /> Emacs</h1>
+
+> An AI copilot for your Second Brain in Emacs
+
+<img src="https://stable.melpa.org/packages/khoj-badge.svg" width="150" alt="Melpa Stable Badge" />
+<img src="https://melpa.org/packages/khoj-badge.svg" width="150" alt="Melpa Badge" />
+
+<img src="https://github.com/khoj-ai/khoj/actions/workflows/build_khoj_el.yml/badge.svg" width="150" alt="Build Badge" />
+<img src="https://github.com/khoj-ai/khoj/actions/workflows/test_khoj_el.yml/badge.svg" width="150" alt="Test Badge" />
+
+
+## Features
+- **Chat**
+  - **Faster answers**: Find answers quickly, from your private notes or the public internet
+  - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+  - **Iterative discovery**: Iteratively explore and re-discover your notes
+- **Search**
+  - **Natural**: Advanced natural language understanding using Transformer based ML Models
+  - **Incremental**: Incremental search for a fast, search-as-you-type experience
+
+## Interface
+
+| Search | Chat |
+|:------:|:----:|
+| ![khoj search on emacs](/img/khoj_search_on_emacs.png) | ![khoj chat on emacs](/img/khoj_chat_on_emacs.png) |
+
+## Setup
+1. Generate an API key on the [Khoj Web App](https://app.khoj.dev/config#clients)
+2. Add below snippet to your Emacs config file, usually at `~/.emacs.d/init.el`
+
+
+#### **Direct Install**
+*Khoj will index your org-agenda files, by default*
+
+```elisp
+;; Install Khoj.el
+M-x package-install khoj
+
+; Set your Khoj API key
+(setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY")
+```
+
+#### **Minimal Install**
+*Khoj will index your org-agenda files, by default*
+
+```elisp
+;; Install Khoj client from MELPA Stable
+(use-package khoj
+  :ensure t
+  :pin melpa-stable
+  :bind ("C-c s" . 'khoj)
+  :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"))
+```
+
+#### **Standard Install**
+*Configures the specified org files, directories to be indexed by Khoj*
+
+```elisp
+;; Install Khoj client from MELPA Stable
+(use-package khoj
+  :ensure t
+  :pin melpa-stable
+  :bind ("C-c s" . 'khoj)
+  :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
+                khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
+                khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
+```
+
+#### **Straight.el**
+*Configures the specified org files, directories to be indexed by Khoj*
+
+```elisp
+;; Install Khoj client using Straight.el
+(use-package khoj
+  :after org
+  :straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el"))
+  :bind ("C-c s" . 'khoj)
+  :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
+                khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
+                khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
+```
+
+## Use
+### Search
+See [Khoj Search](/features/search.md) for details
+1. Hit  `C-c s s` (or `M-x khoj RET s`) to open khoj search
+2. Enter your query in natural language<br/>
+  E.g *"What is the meaning of life?"*, *"My life goals for 2023"*
+
+### Chat
+See [Khoj Chat](/features/chat.md) for details
+1. Hit `C-c s c` (or `M-x khoj RET c`) to open khoj chat
+2. Ask questions in a natural, conversational style<br/>
+  E.g *"When did I file my taxes last year?"*
+
+### Find Similar Entries
+This feature finds entries similar to the one you are currently on.
+1. Move cursor to the org-mode entry, markdown section or text paragraph you want to find similar entries for
+2. Hit `C-c s f` (or `M-x khoj RET f`) to find similar entries
+
+### Advanced Usage
+- Add [query filters](https://github.com/khoj-ai/khoj/#query-filters) during search to narrow down results further
+  e.g `What is the meaning of life? -"god" +"none" dt>"last week"`
+
+- Use `C-c C-o 2` to open the current result at cursor in its source org file
+  - This calls `M-x org-open-at-point` on the current entry and opens the second link in the entry.
+  - The second link is the entries [org-id](https://orgmode.org/manual/Handling-Links.html#FOOT28), if set, or the heading text.
+    The first link is the line number of the entry in the source file. This link is less robust to file changes.
+  - Note: If you have [speed keys](https://orgmode.org/manual/Speed-Keys.html) enabled, `o 2` will also work
+
+### Khoj Menu
+![](/img/khoj_emacs_menu.png)
+Hit `C-c s` (or `M-x khoj`) to open the khoj menu above. Then:
+- Hit `t` until you preferred content type is selected in the khoj menu
+  `Content Type` specifies the content to perform `Search`, `Update` or `Find Similar` actions on
+- Hit `n` twice and then enter number of results you want to see
+  `Results Count` is used by the `Search` and `Find Similar` actions
+- Hit `-f u` to `force` update the khoj content index
+  The `Force Update` switch is only used by the `Update` action
+
+## Upgrade
+Use your Emacs package manager to upgrade `khoj.el`
+<!-- tabs:start -->
+
+#### **With MELPA**
+1. Run `M-x package-refresh-content`
+2. Run `M-x package-reinstall khoj`
+
+#### **With Straight.el**
+- Run `M-x straight-pull-package khoj`
+
+<!-- tabs:end -->
--- a/documentation/docs/clients/obsidian.md
+++ b/documentation/docs/clients/obsidian.md
@@ -0,0 +1,63 @@
+---
+sidebar_position: 3
+---
+
+# Obsidian
+
+Connect Obsidian to Khoj to search your notes and the web, and chat with your Second Brain.
+
+<h1><img src="/img/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo" /> Obsidian</h1>
+
+> An AI copilot for your Second Brain in Obsidian
+
+## Features
+- **Chat**
+  - **Faster answers**: Find answers quickly, from your private notes or the public internet
+  - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+  - **Iterative discovery**: Iteratively explore and re-discover your notes
+- **Search**
+  - **Natural**: Advanced natural language understanding using Transformer based ML Models
+  - **Incremental**: Incremental search for a fast, search-as-you-type experience
+
+## Interface
+
+| Search | Chat |
+|:------:|:----:|
+| ![](/img/khoj_search_on_obsidian.png) | ![](/img/khoj_chat_on_obsidian.png) |
+
+
+## Setup
+
+  1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel
+  2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian
+  3. Generate an API key on the [Khoj Web App](https://app.khoj.dev/config#clients)
+  4. Set your Khoj API Key in the Khoj plugin settings in Obsidian
+
+See the official [Obsidian Plugin Docs](https://help.obsidian.md/Extending+Obsidian/Community+plugins) for more details on installing Obsidian plugins.
+
+## Use
+### Chat
+Run *Khoj: Chat* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) and ask questions in a natural, conversational style.<br />
+E.g *"When did I file my taxes last year?"*
+
+See [Khoj Chat](/docs/features/chat) for more details
+
+### Find Similar Notes
+To see other notes similar to the current one, run *Khoj: Find Similar Notes* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
+
+### Search
+Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Search* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
+
+See [Khoj Search](/docs/features/search) for more details. Use [query filters](/docs/miscellaneous/advanced#query-filters) to limit entries to search
+
+[search_demo](https://user-images.githubusercontent.com/6413477/218801155-cd67e8b4-a770-404a-8179-d6b61caa0f93.mp4 ':include :type=mp4')
+
+## Upgrade
+  1. Open *Community plugins* tab in Obsidian settings
+  2. Click the *Check for updates* button
+  3. Click the *Update* button next to Khoj, if available
+
+## Troubleshooting
+  - Open the Khoj plugin settings pane, to configure Khoj
+  - Toggle Enable/Disable Khoj, if setting changes have not applied
+  - Click *Update* button to force index to refresh, if results are failing or stale
--- a/documentation/docs/clients/web.md
+++ b/documentation/docs/clients/web.md
@@ -0,0 +1,29 @@
+---
+sidebar_position: 4
+---
+
+# Web
+
+Without any desktop clients, you can get started with using Khoj on the web for chat. Bear in mind you do need one of the desktop clients in order to index and sync your data with Khoj.
+
+<h1><img src="/img/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo" /> Web</h1>
+
+> An AI copilot for your Second Brain
+
+## Features
+- **Chat**
+  - **Faster answers**: Find answers quickly, from your private notes or the public internet
+  - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+  - **Iterative discovery**: Iteratively explore and re-discover your notes
+- **Search**
+  - **Natural**: Advanced natural language understanding using Transformer based ML Models
+  - **Incremental**: Incremental search for a fast, search-as-you-type experience
+
+## Setup
+No setup required. The Khoj web app is the default interface to Khoj. You can access it from any web browser. Try it on [Khoj Cloud](https://app.khoj.dev)
+
+## Interface
+
+| Search | Chat |
+|:------:|:----:|
+| ![](/img/khoj_search_on_web.png) | ![](/img/khoj_chat_on_web.png) |