khoj/docs at f77336ba61e8cc055d3996134a0775c288f2b6f4 - khoj

klbr/khoj

mirror of https://github.com/khoaliber/khoj.git synced 2026-03-02 21:19:12 +00:00

Files

Simon Butler e3f8a95784 Update emacs.md (#510 )

Minor correction for emacs-lisp in minimal install

2023-10-19 12:28:08 -07:00

assets

Use 500px png of khoj logo instead svg for much smaller asset size

2023-08-07 18:27:11 -07:00

_coverpage.md

📝 Add a documentation base for Khoj! (#333 )

2023-07-20 22:34:25 -07:00

_sidebar.md

Deprecate desktop build instructions from old setup

2023-09-25 22:02:02 -07:00

.nojekyll

📝 Add a documentation base for Khoj! (#333 )

2023-07-20 22:34:25 -07:00

advanced.md

Document slash command and query filter in docs for chat and search

2023-08-28 11:00:52 -07:00

chat.md

Set >=6Gb RAM required for offline chat

2023-10-18 12:05:54 -07:00

CNAME

Create CNAME to make Docs accessible at docs.khoj.dev

2023-07-20 23:24:08 -07:00

credits.md

Add instructions for installing the desktop app and opting out of telemetry

2023-07-30 22:26:52 -07:00

demos.md

Update Screenshots and Demos in Docs

2023-07-21 15:22:35 -07:00

desktop_installation.md

Deprecate desktop build instructions from old setup

2023-09-25 22:02:02 -07:00

development.md

fixed reference link to landing page (#417 )

2023-08-04 10:38:14 -07:00

emacs.md

Update emacs.md (#510 )

2023-10-19 12:28:08 -07:00

features.md

Align docs landing page with updated github readme

2023-07-29 12:42:36 -07:00

github_integration.md

📝 Add a documentation base for Khoj! (#333 )

2023-07-20 22:34:25 -07:00

index.html

Fix diff blocks, links, remove footnotes & rearrange sections in docs

2023-07-21 00:58:30 -07:00

notion_integration.md

Fix #353 : Remove references to localhost:8000

2023-07-28 13:57:00 +05:30

obsidian.md

Use 500px png of khoj logo instead svg for much smaller asset size

2023-08-07 18:27:11 -07:00

performance.md

Fix diff blocks, links, remove footnotes & rearrange sections in docs

2023-07-21 00:58:30 -07:00

README.md

Add a link to the FAQ in our docs (#438 )

2023-08-14 15:05:08 -07:00

search.md

Document slash command and query filter in docs for chat and search

2023-08-28 11:00:52 -07:00

setup.md

Update setup instructions

2023-09-26 09:40:36 -07:00

telemetry.md

Clarify usage in telmetry.md

2023-07-30 22:37:20 -07:00

web.md

Use 500px png of khoj logo instead svg for much smaller asset size

2023-08-07 18:27:11 -07:00

windows_install.md

Update Screenshots and Demos in Docs

2023-07-21 15:22:35 -07:00

README.md

An AI personal assistant for your digital brain

📜 Explore Code • 🌍 Try Khoj Cloud • 💬 Get Involved

Introduction

Welcome to the Khoj Docs! This is the best place to get started with Khoj.

Khoj is a desktop application to search and chat with your notes, documents and images
It is an offline-first, open source AI personal assistant accessible from your Emacs, Obsidian or Web browser
It works with jpeg, markdown, notion org-mode, pdf files and github repositories
If you have more questions, check out the FAQ - it's a live Khoj instance indexing our Github repository!

Quickstart

Click here for full setup instructions

pip install khoj-assistant && khoj

Overview

Search

Local: Your personal data stays local. All search and indexing is done on your machine.
Incremental: Incremental search for a fast, search-as-you-type experience

Chat

Faster answers: Find answers faster, smoother than search. No need to manually scan through your notes to find answers.
Iterative discovery: Iteratively explore and (re-)discover your notes
Assisted creativity: Smoothly weave across answers retrieval and content generation
Online or Offline: Choose online or offline chat depending on your requirements