sij/khoj

mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-22 20:28:09 +00:00

History

Debanjum 0ae21e5628 Some checks failed dockerize / Publish Khoj Docker Images (push) Has been cancelled Details build and deploy github pages for documentation / deploy (push) Has been cancelled Details pre-commit / Setup Application and Lint (push) Has been cancelled Details pypi / Publish Python Package to PyPI (push) Has been cancelled Details test / Run Tests (push) Has been cancelled Details dockerize / manifest (push) Has been cancelled Details Use icons, not text labels, for sidebar nav items on docs website		2024-12-17 20:49:09 -08:00
..
assets	Update the desktop instructions	2024-12-05 17:39:16 -08:00
docs	Include resend as a default dependency, rather than restricting to prod	2024-12-16 22:24:41 -08: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	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

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.