mirror of
https://github.com/StanGirard/quivr.git
synced 2024-12-25 12:22:58 +03:00
82ab6d007d
By not specifying '-f docker-compose.yml' in the docker compose command, it allows more flexible use of configuration files. docker-compose.yml is already the default config file when none is specified, and this also allows overrides via docker-compose.override.yml, which is recognized by default. |
||
---|---|---|
.. | ||
docs | ||
src | ||
static | ||
.gitignore | ||
babel.config.js | ||
docusaurus.config.js | ||
package-lock.json | ||
package.json | ||
README.md | ||
sidebars.js |
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.