mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-22 11:33:57 +03:00
0fd99fe5b2
This pull request updates the API documentation to include new sections on configuring Quivr and contacting the Quivr team. It also removes the "API Brains" section from the documentation. |
||
|---|---|---|
| .. | ||
| _snippets | ||
| developers | ||
| getting-started | ||
| images | ||
| use-cases | ||
| video | ||
| .gitignore | ||
| configuring.mdx | ||
| contact-us.mdx | ||
| favicon.ico | ||
| favicon.svg | ||
| install.mdx | ||
| intro.mdx | ||
| mint.json | ||
| README.md | ||
| roadmap.mdx | ||
| slackbot.mdx | ||
| tech-design.mdx | ||
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.