QuivrHQ/quivr
1
1
Fork 0
mirror of https://github.com/QuivrHQ/quivr.git synced 2024-08-17 02:10:31 +03:00
Code Issues Packages Projects Releases Wiki Activity
analytics/tracking
quivr/docs
History
Stan Girard 8382dde575 feat: 🎸 local 
all local in 60 seconds
2023-12-02 15:43:05 +01:00
..
docs feat: 🎸 local 2023-12-02 15:43:05 +01:00
src feat(docs): reworked the website (#1523) 2023-10-30 17:08:15 +01:00
static docs: add api based brains (#1685) 2023-11-22 17:01:56 +01: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 feat: 🎸 docs (#1561) 2023-11-02 14:42:39 +01:00
package.json feat: 🎸 docs (#1561) 2023-11-02 14:42:39 +01: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
yarn.lock feat: 🎸 docs (#1561) 2023-11-02 14:42:39 +01:00

README.md

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.