mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-02 13:18:18 +00:00
9b991eb4fe
* Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
---
|
|
sidebar_position: 0
|
|
---
|
|
|
|
# Overview
|
|
|
|
Learn about Khoj and its features.
|
|
|
|
<p align="center"><img src="/img/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo"></img></p>
|
|
|
|
<div align="center">
|
|
|
|
[](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
|
|
[](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
|
|
[](https://pypi.org/project/khoj-assistant/)
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
<b>An AI copilot for your Second Brain</b>
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
[📜 Explore Code](https://github.com/khoj-ai/khoj)
|
|
<span> • </span>
|
|
[🌍 Try Khoj Cloud](https://khoj.dev)
|
|
<span> • </span>
|
|
[💬 Get Involved](https://discord.gg/BDgyabRM6e)
|
|
|
|
</div>
|
|
|
|
## Introduction
|
|
Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features.
|
|
|
|
- Khoj is an open source, personal AI
|
|
- You can [chat](/features/chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond
|
|
- Quickly [find](/features/search.md) relevant notes and documents using natural language
|
|
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](/online-data-sources/notion_integration.md) and [github repositories](/online-data-sources/github_integration.md)
|
|
- Access it from your [Emacs](/clients/emacs.md), [Obsidian](/clients/obsidian.md), [Web browser](/clients/web.md) or the [Khoj Desktop app](/clients/desktop.md)
|
|
- You can self-host Khoj on your consumer hardware or share it with your family, friends or team from your private cloud
|
|
|
|
## Quickstart
|
|
- [Try Khoj Cloud](https://app.khoj.dev) to get started quickly
|
|
- [Read these instructions](/get-started/setup.mdx) to self-host a private instance of Khoj
|
|
|
|
## At a Glance
|
|
<img src="https://docs.khoj.dev/assets/khoj_search_on_web.png" width="400px" />
|
|
<span> </span>
|
|
<img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px" />
|
|
|
|
#### [Search](/features/search.md)
|
|
- **Natural**: Use natural language queries to quickly find relevant notes and documents.
|
|
- **Incremental**: Incremental search for a fast, search-as-you-type experience
|
|
|
|
#### [Chat](/features/chat.md)
|
|
- **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
|