khoj/documentation
Debanjum Singh Solanky bdb81260ac Update docs to mention using Llama 3.1 and 20K max prompt size for it
Update stale credits to better reflect bigger open source dependencies
2024-08-22 20:27:58 -07:00
..
assets Use the newer, simpler favicon across desktop and documentation. Update the macos icon set 2024-08-05 14:06:04 +05:30
docs Update docs to mention using Llama 3.1 and 20K max prompt size for it 2024-08-22 20:27:58 -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 Upgrade Documentation packages 2024-06-22 17:38:48 +05:30

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.