sij/khoj

mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-18 10:37:11 +00:00

History

aditya218 9be26e1bd2 Some checks are pending build and deploy github pages for documentation / deploy (push) Waiting to run Details Fix documentation to point to local environment image_generation.md (#1005 ) Fix documentation to point to local environment.		2024-12-11 16:12:25 -08:00
..
assets	Update the desktop instructions	2024-12-05 17:39:16 -08:00
docs	Fix documentation to point to local environment image_generation.md (#1005 )	2024-12-11 16:12:25 -08:00
src	Fix chatwoot import issue by checking whether we're in an execution environment before loading the script	2024-12-08 17:16:20 -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	Add Chatwoot to documentation	2024-12-08 16:51:43 -08:00
package.json	Add a sitemap plugin	2024-04-10 14:35:04 +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	Upgrade server, documentation dependencies. Spell fix docker-compose.yml	2024-12-10 15:47:47 -08:00

Website

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

$ yarn

$ 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.

$ yarn build

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

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.