sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 15:38:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
khoj/documentation
History
Debanjum Singh Solanky cf08eaf786 Add comments explaining each field in the search model config in DB
2024-04-25 13:54:13 +05:30
..
assets Add updated information in docs about the Notion integration 2024-04-05 15:31:43 +05:30
docs Add comments explaining each field in the search model config in DB 2024-04-25 13:54:13 +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 Add a sitemap plugin 2024-04-10 14:35:04 +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 Add a sitemap plugin 2024-04-10 14:35:04 +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.