mirror of https://github.com/khoj-ai/khoj.git synced 2026-07-30 17:27:38 -04:00

Files

Ankit Kotnala f285132ff6 Fix contributor guide typos (#1319 )

## Fixes a few small typos in the contributor development guide.

This updates “corner-store” to “cornerstone”, fixes “wil” to “will”, and
makes the PR guidance sentence grammatical. No behavior changes.

2026-06-24 11:54:09 -07:00

assets

Update the desktop instructions

2024-12-05 17:39:16 -08:00

docs

Fix contributor guide typos (#1319 )

2026-06-24 11:54:09 -07:00

src

Use icons, not text labels, for sidebar nav items on docs website

2024-12-17 20:49:09 -08:00

.gitignore

Migrate to using docusaurus, rather than docsify for documentation (#603 )

2024-01-07 20:28:15 +05:30

babel.config.js

Migrate to using docusaurus, rather than docsify for documentation (#603 )

2024-01-07 20:28:15 +05:30

docusaurus.config.js

Unify login via popup on home. No need for separate login html page.

2025-12-29 00:57:17 -08:00

package.json

Bump server, doc and client (web, obsidian, desktop) dependencies

2026-06-24 08:45:12 -07:00

README.md

Migrate to using docusaurus, rather than docsify for documentation (#603 )

2024-01-07 20:28:15 +05:30

sidebars.js

Migrate to using docusaurus, rather than docsify for documentation (#603 )

2024-01-07 20:28:15 +05:30

yarn.lock

Bump server, doc and client (web, obsidian, desktop) dependencies

2026-06-24 08:45:12 -07:00

README.md

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.