klbr/khoj

mirror of https://github.com/khoaliber/khoj.git synced 2026-03-02 13:18:18 +00:00

Files

Debanjum Singh Solanky 26c39576df Add Documentation for the settings on the Khoj Admin Panel

This is an initial pass to add documentation for all the knobs
available on the Khoj Admin panel.

It should shed some light onto what each admin setting is for and how
they can be customized when self hosting.

Resolves #831

2024-09-21 14:06:40 -07:00

assets

Add Documentation for the settings on the Khoj Admin Panel

2024-09-21 14:06:40 -07:00

docs

Add Documentation for the settings on the Khoj Admin Panel

2024-09-21 14:06:40 -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

Update documentation package dependencies

2024-09-10 14:18:56 -07: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.