Skip to content

Commit 5dea9ef

Browse files
debanjumdebanjum
committed
Add selected OS tab to url in documentation to ease link sharing
1 parent 87c52df commit 5dea9ef

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

‎documentation/docs/contributing/development.mdx

+9-9
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import Tabs from '@theme/Tabs';
2020
import TabItem from '@theme/TabItem';
2121
```
2222

23-
<Tabs>
23+
<Tabs groupId="operating-systems" queryString="os">
2424
<TabItem value="macos" label="MacOS">
2525
```shell
2626
# Get Khoj Code
@@ -33,7 +33,7 @@ python3 -m venv .venv && source .venv/bin/activate
3333
pip install -e '.[dev]'
3434
```
3535
</TabItem>
36-
<TabItem value="win" label="Windows">
36+
<TabItem value="windows" label="Windows">
3737
```shell
3838
# Get Khoj Code
3939
git clone https://github.com/khoj-ai/khoj && cd khoj
@@ -45,7 +45,7 @@ python3 -m venv .venv && .venv\Scripts\activate
4545
pip install -e '.[dev]'
4646
```
4747
</TabItem>
48-
<TabItem value="unix" label="Linux">
48+
<TabItem value="linux" label="Linux">
4949
```shell
5050
# Get Khoj Code
5151
git clone https://github.com/khoj-ai/khoj && cd khoj
@@ -63,15 +63,15 @@ pip install -e '.[dev]'
6363

6464
Khoj uses the `pgvector` package to store embeddings of your index in a Postgres database. To use this, you need to have Postgres installed.
6565

66-
<Tabs groupId="operating-systems">
66+
<Tabs groupId="operating-systems" queryString="os">
6767
<TabItem value="macos" label="MacOS">
6868
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
6969
</TabItem>
70-
<TabItem value="win" label="Windows">
70+
<TabItem value="windows" label="Windows">
7171
1. Use the [recommended installer](https://www.postgresql.org/download/windows/).
7272
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#windows) in case you need to manually install it. Windows support is experimental for pgvector currently, so we recommend using Docker. Refer to Windows Installation Notes below if there are errors.
7373
</TabItem>
74-
<TabItem value="unix" label="Linux">
74+
<TabItem value="linux" label="Linux">
7575
From [official instructions](https://wiki.postgresql.org/wiki/Apt)
7676
</TabItem>
7777
<TabItem value="source" label="From Source">
@@ -84,18 +84,18 @@ Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with
8484

8585
Make sure to update your environment variables to match your Postgres configuration if you're using a different name. The default values should work for most people. When prompted for a password, you can use the default password `postgres`, or configure it to your preference. Make sure to set the environment variable `POSTGRES_PASSWORD` to the same value as the password you set here.
8686

87-
<Tabs groupId="operating-systems">
87+
<Tabs groupId="operating-systems" queryString="os">
8888
<TabItem value="macos" label="MacOS">
8989
```shell
9090
createdb khoj -U postgres --password
9191
```
9292
</TabItem>
93-
<TabItem value="win" label="Windows">
93+
<TabItem value="windows" label="Windows">
9494
```shell
9595
createdb -U postgres khoj --password
9696
```
9797
</TabItem>
98-
<TabItem value="unix" label="Linux">
98+
<TabItem value="linux" label="Linux">
9999
```shell
100100
sudo -u postgres createdb khoj --password
101101
```

‎documentation/docs/get-started/setup.mdx

+12-12
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,16 @@ Khoj should now be running at http://localhost:42110! You can see the web UI in
4848

4949
Khoj uses Postgres DB for all server configuration and to scale to multi-user setups. It uses the pgvector package in Postgres to manage your document embeddings. Both Postgres and pgvector need to be installed for Khoj to work.
5050

51-
<Tabs groupId="operating-systems">
51+
<Tabs groupId="operating-systems" queryString="os">
5252
<TabItem value="macos" label="MacOS">
5353
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
5454
</TabItem>
55-
<TabItem value="win" label="Windows">
55+
<TabItem value="windows" label="Windows">
5656
For detailed instructions and troubleshooting, see [this section](/contributing/development#2-postgres-installation--setup).
5757
1. Use the [recommended installer](https://www.postgresql.org/download/windows/).
5858
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#windows) in case you need to manually install it. Windows support is experimental for pgvector currently, so we recommend using Docker.
5959
</TabItem>
60-
<TabItem value="unix" label="Linux">
60+
<TabItem value="linux" label="Linux">
6161
From [official instructions](https://wiki.postgresql.org/wiki/Apt)
6262
</TabItem>
6363
<TabItem value="source" label="From Source">
@@ -70,18 +70,18 @@ Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with
7070

7171
Make sure to update your environment variables to match your Postgres configuration if you're using a different name. The default values should work for most people. When prompted for a password, you can use the default password `postgres`, or configure it to your preference. Make sure to set the environment variable `POSTGRES_PASSWORD` to the same value as the password you set here.
7272

73-
<Tabs groupId="operating-systems">
73+
<Tabs groupId="operating-systems" queryString="os">
7474
<TabItem value="macos" label="MacOS">
7575
```shell
7676
createdb khoj -U postgres --password
7777
```
7878
</TabItem>
79-
<TabItem value="win" label="Windows">
79+
<TabItem value="windows" label="Windows">
8080
```shell
8181
createdb -U postgres khoj --password
8282
```
8383
</TabItem>
84-
<TabItem value="unix" label="Linux">
84+
<TabItem value="linux" label="Linux">
8585
```shell
8686
sudo -u postgres createdb khoj --password
8787
```
@@ -96,7 +96,7 @@ sudo -u postgres createdb khoj --password
9696

9797
Run the following command in your terminal to install the Khoj server.
9898

99-
<Tabs groupId="operating-systems">
99+
<Tabs groupId="operating-systems" queryString="os">
100100
<TabItem value="macos" label="MacOS">
101101
```shell
102102
# ARM/M1+ Machines
@@ -106,7 +106,7 @@ MAKE_ARGS="-DLLAMA_METAL=on" python -m pip install khoj
106106
python -m pip install khoj
107107
```
108108
</TabItem>
109-
<TabItem value="win" label="Windows">
109+
<TabItem value="windows" label="Windows">
110110
In PowerShell on Windows
111111
```shell
112112
# 1. (Optional) To use NVIDIA (CUDA) GPU
@@ -120,7 +120,7 @@ python -m pip install khoj
120120
py -m pip install khoj
121121
```
122122
</TabItem>
123-
<TabItem value="unix" label="Linux">
123+
<TabItem value="linux" label="Linux">
124124
```shell
125125
# CPU
126126
python -m pip install khoj
@@ -138,21 +138,21 @@ python -m pip install khoj
138138

139139
Before getting started, configure the following environment variables in your terminal for the first run
140140

141-
<Tabs groupId="operating-systems">
141+
<Tabs groupId="operating-systems" queryString="os">
142142
<TabItem value="macos" label="MacOS">
143143
```shell
144144
export KHOJ_ADMIN_EMAIL=<your-email>
145145
export KHOJ_ADMIN_PASSWORD=<your-password>
146146
```
147147
</TabItem>
148-
<TabItem value="win" label="Windows">
148+
<TabItem value="windows" label="Windows">
149149
If you're using PowerShell:
150150
```shell
151151
$env:KHOJ_ADMIN_EMAIL="<your-email>"
152152
$env:KHOJ_ADMIN_PASSWORD="<your-password>"
153153
```
154154
</TabItem>
155-
<TabItem value="unix" label="Linux">
155+
<TabItem value="linux" label="Linux">
156156
```shell
157157
export KHOJ_ADMIN_EMAIL=<your-email>
158158
export KHOJ_ADMIN_PASSWORD=<your-password>

0 commit comments

Comments
 (0)