sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-27 09:25:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
khoj/documentation
History
Debanjum Singh Solanky 474afa5efe Document using OpenAI-compatible LLM API server for Khoj chat 
This allows using open or commerical, local or hosted LLM models that
are not supported in Khoj by default.

It also allows users to use other local LLM API servers that support
their GPU

Closes #407
2024-02-02 10:31:27 +05:30
..
assets Use Khoj Client, Data sources diagrams in feature docs 2024-01-08 01:58:57 +05:30
docs Document using OpenAI-compatible LLM API server for Khoj chat 2024-02-02 10:31:27 +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 Include info about privacy in the docs (#631) 2024-01-29 17:47:23 +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

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.