sij/khoj

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

History

sabaimran 9310f88537 Add quadratic equation gif to docs		2024-09-11 20:07:57 -07:00
..
assets	Add quadratic equation gif to docs	2024-09-11 20:07:57 -07:00
docs	Update the documentation with swanky new demo videos	2024-09-11 19:57:10 -07:00
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	Update Khoj tagline to "Your Second Brain"	2024-08-05 02:27:05 +05:30
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	Update documentation package dependencies	2024-09-10 14:18:56 -07: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.