sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2025-02-17 16:14:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
khoj/documentation/docs/get-started/overview.md

42 lines
1.9 KiB
Markdown
Raw Normal View History

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
2024-01-07 20:28:15 +05:30
---
sidebar_position: 0
Make the docs overview page as the main docs landing page - Make the docs overview page available at docs.khoj.dev root instead of under docs.khoj.dev/docs path - Remove the new landing page, it is unnecessary. - Remove /docs path prefix from links to internal doc pages - Remove .md path suffix in internal doc pages for consistency
2024-01-08 00:32:23 +05:30
slug: /
Add and update documentation for setting up khoj with an openai proxy server or offline llm
2024-04-27 20:16:32 +05:30
keywords: ["khoj", "khoj ai", "khoj docs", "khoj documentation", "khoj features", "khoj overview", "khoj quickstart", "khoj chat", "khoj search", "khoj cloud", "khoj self-host", "khoj setup", "open source ai", "local llm", "ai copilot", "second brain ai", "ai search engine"]
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
2024-01-07 20:28:15 +05:30
---
# Overview
<p align="center"><img src="/img/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo"></img></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 12:42:36 -07:00
<div align="center">
Fix image urls on docs overview page. Remove logo header in client docs
2024-01-07 23:40:05 +05:30
<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 12:42:36 -07:00
</div>
Fix image urls on docs overview page. Remove logo header in client docs
2024-01-07 23:40:05 +05:30
<br />
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 12:42:36 -07: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-20 22:34:25 -07:00
Fix image urls on docs overview page. Remove logo header in client docs
2024-01-07 23:40:05 +05:30
[📜 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-20 22:34:25 -07: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 12:42:36 -07: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-20 22:34:25 -07: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 12:42:36 -07: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-18 17:25:52 -08: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-20 22:34:25 -07: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-18 17:25:52 -08:00
- Khoj is an open source, personal AI
Add a demo for the khoj mini application, minor updates to other pages, remove out of date demos page
2024-07-08 16:33:47 +05:30
- You can [chat](/features/chat) with it about anything. It'll use files you shared with it to respond, when relevant. It can also access information from the public internet.
Make the docs overview page as the main docs landing page - Make the docs overview page available at docs.khoj.dev root instead of under docs.khoj.dev/docs path - Remove the new landing page, it is unnecessary. - Remove /docs path prefix from links to internal doc pages - Remove .md path suffix in internal doc pages for consistency
2024-01-08 00:32:23 +05:30
- Quickly [find](/features/search) relevant notes and documents using natural language
Add and update documentation for setting up khoj with an openai proxy server or offline llm
2024-04-27 20:16:32 +05:30
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](/data-sources/notion_integration) and [github repositories](/data-sources/github_integration)
Add a demo for the khoj mini application, minor updates to other pages, remove out of date demos page
2024-07-08 16:33:47 +05:30
- Access it from your [Emacs](/clients/emacs), [Obsidian](/clients/obsidian), the [Khoj desktop app](/clients/desktop), or [any web browser](/clients/web)
Use Khoj Client, Data sources diagrams in feature docs
2024-01-08 01:52:12 +05:30
- Use [cloud](https://app.khoj.dev/login) to access your Khoj anytime from anywhere, [self-host](/get-started/setup) on consumer hardware for privacy
📝 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-20 22:34:25 -07: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 12:42:36 -07: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-18 17:25:52 -08:00
- [Try Khoj Cloud](https://app.khoj.dev) to get started quickly
Make the docs overview page as the main docs landing page - Make the docs overview page available at docs.khoj.dev root instead of under docs.khoj.dev/docs path - Remove the new landing page, it is unnecessary. - Remove /docs path prefix from links to internal doc pages - Remove .md path suffix in internal doc pages for consistency
2024-01-08 00:32:23 +05:30
- [Read these instructions](/get-started/setup) 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 12:42:36 -07:00
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
2024-01-07 20:28:15 +05:30
## At a Glance
Move some gifs to the assets s3 bucket and add instructions for Ollama, shareable conversations
2024-05-25 01:08:20 +05:30
![demo_chat](https://assets.khoj.dev/using_khoj_for_studying.gif)
Reference in a new issue Copy permalink