diff --git a/docs/README.md b/docs/README.md index 75cfcb81..704590f6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,54 +1,53 @@ -

Khoj Logo

+

Khoj Logo

+ +
[![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml) [![dockerize](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj) [![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj-assistant/) -# Khoj -*An AI personal assistant for your digital brain* +
-Welcome to the Khoj Docs! This is the best place to get started with Khoj. Check out our [Github](https://github.com/khoj-ai/khoj) to explore the code or our [Website](https://khoj.dev) for an invite up to Khoj cloud. +
+An AI personal assistant for your digital brain -Khoj gives you lightning fast, offline search on your personal machine and gives you the power to talk to your notes. +
-**Supported Plugins** +
-[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#readme) -[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#readme) +[📜 Explore Code](https://github.com/khoj-ai/khoj) +  •   +[🌍 Try Khoj Cloud](https://khoj.dev) +  •   +[💬 Get Involved](https://discord.gg/BDgyabRM6e) -## Features -- **Search** - - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.* +
+ +## Introduction +Welcome to the Khoj Docs! This is the best place to [get started](./setup.md) with Khoj. + +- Khoj is a desktop application to [search](./search.md) and [chat](./chat.md) with your notes, documents and images +- It is an offline-first, open source AI personal assistant accessible from your [Emacs](./emacs.md), [Obsidian](./obsidian.md) or [Web browser](./web.md) +- It works with jpeg, markdown, [notion](./notion_integration.md) org-mode, pdf files and [github repositories](./github_integration.md) + +## Quickstart +[Click here](/setup) for full setup instructions + +```shell +pip install khoj-assistant && khoj +``` + +## Overview + +   + + +#### [Search](./search.md) + - **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** + +#### [Chat](./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 -- **General** - - **Natural**: Advanced natural language understanding using Transformer based ML Models - - **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models - - **Multiple Sources**: Index your Org-mode and Markdown notes, PDF files, Github repositories, and Photos - - **Multiple Interfaces**: Interact from your [Web Browser](https://docs.khoj.dev/#/web), [Emacs](https://docs.khoj.dev/#/emacs) or [Obsidian](https://docs.khoj.dev/#/obsidian) - -## Install -[Click here](/setup) for full setup instructions. - -## Supported data sources -- markdown* -- org-mode* -- pdf* -- images* -- github -- notion - -\* These data sources are offline only. - -If you're using Github or Notion, you can get on a waitlist for [Khoj Cloud](https://khoj.dev). - -## Credits - -- [Multi-QA MiniLM Model](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [All MiniLM Model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) for Text Search. See [SBert Documentation](https://www.sbert.net/examples/applications/retrieve_rerank/README.html) -- [OpenAI CLIP Model](https://github.com/openai/CLIP) for Image Search. See [SBert Documentation](https://www.sbert.net/examples/applications/image-search/README.html) -- Charles Cave for [OrgNode Parser](http://members.optusnet.com.au/~charles57/GTD/orgnode.html) -- [Org.js](https://mooz.github.io/org-js/) to render Org-mode results on the Web interface -- [Markdown-it](https://github.com/markdown-it/markdown-it) to render Markdown results on the Web interface + - **Online or Offline**: Choose online or offline chat depending on your requirements diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 5713a54a..a02a86b0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -14,7 +14,9 @@ - Data Sources - [Github](github_integration.md) - [Notion](notion_integration.md) +- Miscellaneous - [Advanced](advanced.md) - [Performance](performance.md) + - [Credits](credits.md) - Contributing - [Development](development.md) diff --git a/docs/credits.md b/docs/credits.md new file mode 100644 index 00000000..a3032dce --- /dev/null +++ b/docs/credits.md @@ -0,0 +1,7 @@ +## Credits + +- [Multi-QA MiniLM Model](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [All MiniLM Model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) for Text Search. See [SBert Documentation](https://www.sbert.net/examples/applications/retrieve_rerank/README.html) +- [OpenAI CLIP Model](https://github.com/openai/CLIP) for Image Search. See [SBert Documentation](https://www.sbert.net/examples/applications/image-search/README.html) +- Charles Cave for [OrgNode Parser](http://members.optusnet.com.au/~charles57/GTD/orgnode.html) +- [Org.js](https://mooz.github.io/org-js/) to render Org-mode results on the Web interface +- [Markdown-it](https://github.com/markdown-it/markdown-it) to render Markdown results on the Web interface diff --git a/docs/features.md b/docs/features.md index a1f4184a..3bd8939f 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,13 +1,34 @@ ## Features -- **Search** - - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.* + +#### [Search](./search.md) + - **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** + +#### [Chat](./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 -- **General** + +#### General - **Natural**: Advanced natural language understanding using Transformer based ML Models - **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models - **Multiple Sources**: Index your Org-mode and Markdown notes, PDF files, Github repositories, and Photos - - **Multiple Interfaces**: Interact from your [Web Browser](https://github.com/khoj-ai/khoj/blob/master/src/khoj/interface/web/index.html), [Emacs](https://github.com/khoj-ai/khoj/blob/master//src/interface/emacs/khoj.el) or [Obsidian](https://github.com/khoj-ai/khoj/blob/master/src/interface/obsidian/) + - **Multiple Interfaces**: Interact from your [Web Browser](./web.md), [Emacs](./emacs.md) or [Obsidian](./obsidian.md) + +### Supported Interfaces + +[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](./emacs.md) +  +[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](./obsidian.md) + +### Supported Data Sources +- markdown* +- org-mode* +- pdf* +- images* +- [github](./github_integration.md) +- [notion](./notion_integration.md) + +\* These data sources are offline only. + +If you're using Github or Notion, you can get on a waitlist for [Khoj Cloud](https://khoj.dev).