Elgato_dark/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj synced 2026-04-21 15:57:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
khoj/documentation
History
Debanjum 2423db0186 Remove broken link to deprecated summarize slash command in docs
2025-06-07 13:31:21 -07:00
..
assets Update the desktop instructions 2024-12-05 17:39:16 -08:00
docs Remove broken link to deprecated summarize slash command in docs 2025-06-07 13:31:21 -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 Use icons, not text labels, for sidebar nav items on docs website 2024-12-17 20:49:09 -08:00
package.json Upgrade package dependencies of server, clients and docs 2025-03-12 00:22:08 +05:30
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 documentation dependencies 2025-04-19 18:38:31 +05:30

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.