StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-11-09 17:15:54 +03:00
Code Issues Packages Projects Releases Wiki Activity
be87177366
quivr/docs
History
Mamadou DICKO be87177366
docs: update Quivr doc (#1531) 
Issue: https://github.com/StanGirard/quivr/issues/1526
2023-10-31 18:16:51 +01:00
..
docs docs: update Quivr doc (#1531) 2023-10-31 18:16:51 +01:00
src feat(docs): reworked the website (#1523) 2023-10-30 17:08:15 +01:00
static Feat/docs rework (#1525) 2023-10-30 20:53:39 +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): reworked the website (#1523) 2023-10-30 17:08:15 +01: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

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.