sij/khoj

mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 15:38:55 +01:00

History

sabaimran c24389cff5 Add Algolia to documentation website for better search		2024-01-16 15:53:53 +05:30
..
assets	Use Khoj Client, Data sources diagrams in feature docs	2024-01-08 01:58:57 +05:30
docs	Use Khoj Client, Data sources diagrams in feature docs	2024-01-08 01:58:57 +05:30
src	Customize font styling for documentation	2024-01-08 08:50:42 +05:30
.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 Algolia to documentation website for better search	2024-01-16 15:53:53 +05:30
package-lock.json	Migrate to using docusaurus, rather than docsify for documentation (#603 )	2024-01-07 20:28:15 +05:30
package.json	Migrate to using docusaurus, rather than docsify for documentation (#603 )	2024-01-07 20:28:15 +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	Add a yarn.lock file and use for node.js setup	2024-01-07 20:36:02 +05:30

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.