sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-21 03:47:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
khoj/documentation
History
Debanjum 88aa8c377a
Support online search with Searxng as zero config, self-hostable solution (#1010) 
This allows online search to work out of the box again 
for self-hosting users, as no auth/api key setup required.

Docker users do not need to change anything in their setup flow.
Direct installers can setup Searxng locally or use public instances if
they do not want to use any of the other providers (like Jina, Serper)

Resolves #749. Resolves #990
2024-12-16 18:59:09 -08:00
..
assets Update the desktop instructions 2024-12-05 17:39:16 -08:00
docs Support online search with Searxng as zero config, self-hostable solution (#1010) 2024-12-16 18:59:09 -08:00
src Update the theme color used in our docs to match the theme in our emails 2024-12-16 18:42:50 -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 Add Chatwoot to documentation 2024-12-08 16:51:43 -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.