StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-12-25 20:32:11 +03:00
Code Issues Packages Projects Releases Wiki Activity
5e61445fb2
quivr/docs
History
Mamadou DICKO 6abba91a8f
docs: add auth modes config (#1595) 
issue: https://github.com/StanGirard/quivr/issues/1580

<img width="1512" alt="Screenshot 2023-11-06 at 15 20 31"
src="https://github.com/StanGirard/quivr/assets/63923024/c410383f-3454-4f72-9212-f027ae4e1d6c">
2023-11-06 15:41:07 +01:00
..
docs docs: add auth modes config (#1595) 2023-11-06 15:41:07 +01:00
src feat(docs): reworked the website (#1523) 2023-10-30 17:08:15 +01:00
static docs: ✏️ schema (#1537) 2023-10-31 19:20:07 +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.