sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-18 02:27:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 23
khoj/docs/README.md

54 lines
2.5 KiB
Markdown
Raw Normal View History

Use 500px png of khoj logo instead svg for much smaller asset size The khoj logo svg was 1.3Mb. The 500px png of it is 38Kb. Given all usage of khoj-logo are below 230px this should work fine
2023-08-08 01:21:15 +00:00
<p align="center"><img src="./assets/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo"></p>
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
<div align="center">
📝 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-21 05:34:25 +00:00
[![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/)
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
</div>
<div align="center">
Simplify setup, features since Khoj cloud in docs - No Khoj server setup required to start using Khoj from Obsidian, Emacs - Use tabs for install, upgrade in Emacs with different package managers - Use default subtitles in Khoj Docs - Deduplicate query filters, remove backend setup instructions in plugin pages - Remove stale Setup demo on Khoj Obsidian plugin docs
2023-11-19 01:25:52 +00:00
<b>An AI copilot for your Second Brain</b>
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
</div>
<div align="center">
📝 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-21 05:34:25 +00:00
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
[📜 Explore Code](https://github.com/khoj-ai/khoj)
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
[🌍 Try Khoj Cloud](https://khoj.dev)
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
[💬 Get Involved](https://discord.gg/BDgyabRM6e)
📝 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-21 05:34:25 +00:00
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
</div>
📝 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-21 05:34:25 +00:00
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
## Introduction
Simplify setup, features since Khoj cloud in docs - No Khoj server setup required to start using Khoj from Obsidian, Emacs - Use tabs for install, upgrade in Emacs with different package managers - Use default subtitles in Khoj Docs - Deduplicate query filters, remove backend setup instructions in plugin pages - Remove stale Setup demo on Khoj Obsidian plugin docs
2023-11-19 01:25:52 +00:00
Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features.
📝 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-21 05:34:25 +00:00
Simplify setup, features since Khoj cloud in docs - No Khoj server setup required to start using Khoj from Obsidian, Emacs - Use tabs for install, upgrade in Emacs with different package managers - Use default subtitles in Khoj Docs - Deduplicate query filters, remove backend setup instructions in plugin pages - Remove stale Setup demo on Khoj Obsidian plugin docs
2023-11-19 01:25:52 +00:00
- Khoj is an open source, personal AI
Simplify links in Khoj docs to use page_name.md with no prefixes This allows jumping to page via VSCode IDE and on docs website
2023-11-19 02:17:46 +00:00
- You can [chat](chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond
- Quickly [find](search.md) relevant notes and documents using natural language
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](notion_integration.md) and [github repositories](github_integration.md)
- Access it from your [Emacs](emacs.md), [Obsidian](obsidian.md), [Web browser](web.md) or the [Khoj Desktop app](desktop.md)
- You can self-host Khoj on your consumer hardware or share it with your family, friends or team from your private cloud
📝 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-21 05:34:25 +00:00
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
## Quickstart
Simplify setup, features since Khoj cloud in docs - No Khoj server setup required to start using Khoj from Obsidian, Emacs - Use tabs for install, upgrade in Emacs with different package managers - Use default subtitles in Khoj Docs - Deduplicate query filters, remove backend setup instructions in plugin pages - Remove stale Setup demo on Khoj Obsidian plugin docs
2023-11-19 01:25:52 +00:00
- [Try Khoj Cloud](https://app.khoj.dev) to get started quickly
- [Read these instructions](./setup.md) to self-host a private instance of Khoj
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
## Overview
<img src="https://docs.khoj.dev/assets/khoj_search_on_web.png" width="400px">
<span>&nbsp;&nbsp;</span>
<img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px">
Simplify links in Khoj docs to use page_name.md with no prefixes This allows jumping to page via VSCode IDE and on docs website
2023-11-19 02:17:46 +00:00
#### [Search](search.md)
Simplify setup, features since Khoj cloud in docs - No Khoj server setup required to start using Khoj from Obsidian, Emacs - Use tabs for install, upgrade in Emacs with different package managers - Use default subtitles in Khoj Docs - Deduplicate query filters, remove backend setup instructions in plugin pages - Remove stale Setup demo on Khoj Obsidian plugin docs
2023-11-19 01:25:52 +00:00
- **Natural**: Use natural language queries to quickly find relevant notes and documents.
📝 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-21 05:34:25 +00:00
- **Incremental**: Incremental search for a fast, search-as-you-type experience
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
Simplify links in Khoj docs to use page_name.md with no prefixes This allows jumping to page via VSCode IDE and on docs website
2023-11-19 02:17:46 +00:00
#### [Chat](chat.md)
📝 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-21 05:34:25 +00:00
- **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
Align docs landing page with updated github readme - Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2023-07-29 19:42:36 +00:00
- **Online or Offline**: Choose online or offline chat depending on your requirements
Reference in a new issue Copy permalink