klbr/khoj

mirror of https://github.com/khoaliber/khoj.git synced 2026-03-02 21:19:12 +00:00

Files

Debanjum Singh Solanky d920e4d0a7 Make the docs overview page as the main docs landing page

- Make the docs overview page available at docs.khoj.dev root instead of
under docs.khoj.dev/docs path
  - Remove the new landing page, it is unnecessary.
- Remove /docs path prefix from links to internal doc pages
- Remove .md path suffix in internal doc pages for consistency

2024-01-08 01:13:42 +05:30

assets

Make the docs overview page as the main docs landing page

2024-01-08 01:13:42 +05:30

docs

Make the docs overview page as the main docs landing page

2024-01-08 01:13:42 +05:30

src

Make the docs overview page as the main docs landing page

2024-01-08 01:13: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

Make the docs overview page as the main docs landing page

2024-01-08 01:13:42 +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.