quivr/docs
2024-02-07 13:59:48 -08:00
..
_snippets Update GitHub URLs 2024-02-07 13:59:48 -08:00
api-reference feat: 🎸 docs 2023-12-25 16:08:28 +01:00
developers Update GitHub URLs 2024-02-07 13:59:48 -08:00
examples feat(frontend): Page Header + Begin of Studio (#2151) 2024-02-06 16:05:07 -08:00
getting-started feat(frontend): Page Header + Begin of Studio (#2151) 2024-02-06 16:05:07 -08:00
home Documentation edits made through Mintlify web editor 2024-02-03 19:32:09 -08:00
images docs: ✏️ functions 2023-12-29 11:14:22 +01:00
img docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
video docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
.gitignore feat(docs): added 2023-06-11 15:37:28 +02:00
favicon.ico docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
favicon.svg docs: ✏️ mintlify (#1917) 2023-12-24 17:49:27 +01:00
mint.json Update GitHub URLs 2024-02-07 13:59:48 -08:00
README.md feat(docs): added 2023-06-11 15:37:28 +02:00
roadmap.mdx feat(docs): added homepage (#1919) 2023-12-25 09:02:49 +01: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.