klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-09 05:39:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simplify links in Khoj docs to use page_name.md with no prefixes

Browse Source 
This allows jumping to page via VSCode IDE and on docs website
This commit is contained in:
Debanjum Singh Solanky
2023-11-18 18:17:46 -08:00
parent fc65d8a9fe
commit d0e84385f2
3 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/README.md
View File

@@ -27,12 +27,11 @@
Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features. 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 - Khoj is an open source, personal AI
- You can [chat](./chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond - You can [chat](chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond
- Use natural language to quickly [find](./search.md) relevant notes and documents - Quickly [find](search.md) relevant notes and documents using natural language
- Access it from your [Emacs](./emacs.md), [Obsidian](./obsidian.md), [Web browser](./web.md) or the [Khoj Desktop app](https://khoj.dev/downloads) - It understands pdf, plaintext, markdown, org-mode files, [notion pages](notion_integration.md) and [github repositories](github_integration.md)
- 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 and run Khoj on your consumer hardware or private cloud - You can self-host Khoj on your consumer hardware or share it with your family, friends or team from your private cloud
- It supports multiple users. If you want, you can self-host, a shared assistance server for your family, friends, or team
## Quickstart ## Quickstart
- [Try Khoj Cloud](https://app.khoj.dev) to get started quickly - [Try Khoj Cloud](https://app.khoj.dev) to get started quickly
@@ -43,11 +42,11 @@ Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's
<span>&nbsp;&nbsp;</span> <span>&nbsp;&nbsp;</span>
<img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px"> <img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px">
#### [Search](./search.md) #### [Search](search.md)
- **Natural**: Use natural language queries to quickly find relevant notes and documents. - **Natural**: Use natural language queries to quickly find relevant notes and documents.
- **Incremental**: Incremental search for a fast, search-as-you-type experience - **Incremental**: Incremental search for a fast, search-as-you-type experience
#### [Chat](./chat.md) #### [Chat](chat.md)
- **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers. - **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 - **Iterative discovery**: Iteratively explore and (re-)discover your notes
- **Assisted creativity**: Smoothly weave across answers retrieval and content generation - **Assisted creativity**: Smoothly weave across answers retrieval and content generation

4
docs/emacs.md
View File

@@ -86,13 +86,13 @@ M-x package-install khoj
<!-- tabs:end --> <!-- tabs:end -->
## Use ## Use
### Search ### Search
See [Khoj Search](/search) for details See [Khoj Search](search.md) for details
1. Hit `C-c s s` (or `M-x khoj RET s`) to open khoj search 1. Hit `C-c s s` (or `M-x khoj RET s`) to open khoj search
2. Enter your query in natural language<br/> 2. Enter your query in natural language<br/>
E.g *"What is the meaning of life?"*, *"My life goals for 2023"* E.g *"What is the meaning of life?"*, *"My life goals for 2023"*
### Chat ### Chat
See [Khoj Chat](/chat) for details See [Khoj Chat](chat.md) for details
1. Hit `C-c s c` (or `M-x khoj RET c`) to open khoj chat 1. Hit `C-c s c` (or `M-x khoj RET c`) to open khoj chat
2. Ask questions in a natural, conversational style<br/> 2. Ask questions in a natural, conversational style<br/>
E.g *"When did I file my taxes last year?"* E.g *"When did I file my taxes last year?"*

4
docs/features.md
View File

@@ -1,10 +1,10 @@
## Features ## Features
#### [Search](./search.md) #### [Search](search.md)
- **Local**: Your personal data stays local. All search and indexing is done on your machine. - **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 - **Incremental**: Incremental search for a fast, search-as-you-type experience
#### [Chat](./chat.md) #### [Chat](chat.md)
- **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers. - **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 - **Iterative discovery**: Iteratively explore and (re-)discover your notes
- **Assisted creativity**: Smoothly weave across answers retrieval and content generation - **Assisted creativity**: Smoothly weave across answers retrieval and content generation