quivr/docs
thehunmonkgroup 82ab6d007d
feat: make docker compose command more flexible (#1139)
By not specifying '-f docker-compose.yml' in the docker compose command, it allows
more flexible use of configuration files. docker-compose.yml is already the default
config file when none is specified, and this also allows overrides via
docker-compose.override.yml, which is recognized by default.
2023-09-08 11:17:59 +02:00
..
docs feat: make docker compose command more flexible (#1139) 2023-09-08 11:17:59 +02:00
src docs(brain): improved 2023-06-19 11:58:03 +02:00
static feat(chat): use openai function for answer (#354) 2023-06-22 17:50:06 +02:00
.gitignore feat(docs): added 2023-06-11 15:37:28 +02:00
babel.config.js feat(docs): added 2023-06-11 15:37:28 +02:00
docusaurus.config.js Update docusaurus.config.js (#647) 2023-07-14 07:23:36 +02:00
package-lock.json feat(docs): added 2023-06-11 15:37:28 +02:00
package.json feat(docs): added 2023-06-11 15:37:28 +02:00
README.md feat(docs): added 2023-06-11 15:37:28 +02:00
sidebars.js feat(docs): added 2023-06-11 15:37:28 +02:00

Website

This website is built using Docusaurus 2, 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.